Jump to

• Request
• Response
• Examples

Upload File Attachment v2

post

/jderest/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(optional): string
  Token
• jde-AIS-Auth-Device(optional): string
  Device Name
• jde-AIS-MonitorOnStart(optional): boolean
  Monitor on Start
• jde-AIS-MonitorRequest(optional): string
  Monitor Request

  Allowed Values: [ "monitorRequest", "monitorRequestIO" ]

Form Parameters

• file: file
• moAdd: string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Execution

Body ()

Root Schema : MediaObjectListResponse

Type: object

MediaObjectListResponse is the output of the media object list operation.

Show Source

• mediaObjects(optional): array mediaObjects
  The list of media object items.

{
    "type":"object",
    "properties":{
        "mediaObjects":{
            "type":"array",
            "description":"The list of media object items.",
            "items":{
                "$ref":"#/definitions/MediaObjectListItem"
            }
        }
    },
    "description":"MediaObjectListResponse is the output of the media object list operation."
}

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.

{
    "type":"array",
    "description":"The list of media object items.",
    "items":{
        "$ref":"#/definitions/MediaObjectListItem"
    }
}

Nested Schema : MediaObjectListItem

Type: object

MediaObjectListItem is an individual media object within the response returned from the list operation.

Show Source

• data(optional): 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(optional): string
  An identifier for the device making the service call. If not provided, the requesting IP address is used.
• downloadUrl(optional): string
  For file type media objects this is the download URL needed ot download the item. Pass this value into a download request.
• environment(optional): string
  Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
• file(optional): string
  The location of the file for this media object.
• formName: string
  The name of the form the media object is associated with (for example W01012A).
• isDefaultImage(optional): boolean
  Indicates that this image was set as the default image for this media object structure and key.
• isImage(optional): boolean
  Indicates the file is an image.
• isOLE(optional): boolean
  Indicates the item is an OLE item.
• isShortCut(optional): boolean
  Indicates the item is a shortcut.
• isText(optional): boolean
  Indicates the item is a text type media object.
• isUpdated(optional): boolean
  Indicates the item has been updated.
• isURL(optional): boolean
  Indicates the item is a URL type media object.
• itemName(optional): string
  The name of the media object item.
• jasserver(optional): 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(optional): 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: 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: 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(optional): integer(int32)
  The media object type, 0-Text, 1-File, 5-URL.
• password(optional): string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• psToken(optional): string
  Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
• queue(optional): string
  If the file was from the media object queue, the queue name will be returned.
• role(optional): string
  The role to use for login. If not specified, the default role configured for the AIS Server will be used.
• sequence(optional): integer(int32)
  The sequence number of the media object item.
• token(optional): string
  The AIS token, which is required if other authentication methods are not being used.
• updateDate(optional): string
  The date the media object was last updated.
• updateHourOfDay(optional): integer(int32)
  The hour of the day the item was last updated.
• updateMinuteOfHour(optional): integer(int32)
  The minute of the hour of the day the item was last updated.
• updateSecondOfMinute(optional): integer(int32)
  The second of the minute of the hour day the item was last updated.
• updateUserID(optional): string
  The user that last updated the item.
• username(optional): string
  JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.
• version: string
  The version of the application the media object is associated with (for example ZJDE0001).

{
    "type":"object",
    "required":[
        "formName",
        "moKey",
        "moStructure",
        "version"
    ],
    "properties":{
        "environment":{
            "type":"string",
            "description":"Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used."
        },
        "role":{
            "type":"string",
            "description":"The role to use for login. If not specified, the default role configured for the AIS Server will be used."
        },
        "jasserver":{
            "type":"string",
            "description":"The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used."
        },
        "token":{
            "type":"string",
            "description":"The AIS token, which is required if other authentication methods are not being used."
        },
        "deviceName":{
            "type":"string",
            "description":"An identifier for the device making the service call. If not provided, the requesting IP address is used."
        },
        "psToken":{
            "type":"string",
            "description":"Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server."
        },
        "username":{
            "type":"string",
            "description":"JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used."
        },
        "password":{
            "type":"string",
            "description":"The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used."
        },
        "moStructure":{
            "type":"string",
            "description":"The media object data structure name, for example GT0801 or ABGT, which is a key to the F00165 table where media objects are stored."
        },
        "moKey":{
            "type":"array",
            "description":"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.",
            "items":{
                "type":"string"
            }
        },
        "formName":{
            "type":"string",
            "description":"The name of the form the media object is associated with (for example W01012A)."
        },
        "version":{
            "type":"string",
            "description":"The version of the application the media object is associated with (for example ZJDE0001)."
        },
        "data":{
            "type":"string",
            "description":"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."
        },
        "downloadUrl":{
            "type":"string",
            "description":"For file type media objects this is the download URL needed ot download the item.  Pass this value into a download request."
        },
        "file":{
            "type":"string",
            "description":"The location of the file for this media object."
        },
        "itemName":{
            "type":"string",
            "description":"The name of the media object item."
        },
        "link":{
            "type":"string",
            "description":"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."
        },
        "moType":{
            "type":"integer",
            "format":"int32",
            "description":"The media object type, 0-Text, 1-File, 5-URL."
        },
        "queue":{
            "type":"string",
            "description":"If the file was from the media object queue, the queue name will be returned."
        },
        "sequence":{
            "type":"integer",
            "format":"int32",
            "description":"The sequence number of the media object item."
        },
        "updateDate":{
            "type":"string",
            "description":"The date the media object was last updated."
        },
        "updateHourOfDay":{
            "type":"integer",
            "format":"int32",
            "description":"The hour of the day the item was last updated."
        },
        "updateMinuteOfHour":{
            "type":"integer",
            "format":"int32",
            "description":"The minute of the hour of the day the item was last updated."
        },
        "updateSecondOfMinute":{
            "type":"integer",
            "format":"int32",
            "description":"The second of the minute of the hour day the item was last updated."
        },
        "updateUserID":{
            "type":"string",
            "description":"The user that last updated the item."
        },
        "isDefaultImage":{
            "type":"boolean",
            "description":"Indicates that this image was set as the default image for this media object structure and key."
        },
        "isImage":{
            "type":"boolean",
            "description":"Indicates the file is an image."
        },
        "isOLE":{
            "type":"boolean",
            "description":"Indicates the item is an OLE item."
        },
        "isShortCut":{
            "type":"boolean",
            "description":"Indicates the item is a shortcut."
        },
        "isText":{
            "type":"boolean",
            "description":"Indicates the item is a text type media object."
        },
        "isUpdated":{
            "type":"boolean",
            "description":"Indicates the item has been updated."
        },
        "isURL":{
            "type":"boolean",
            "description":"Indicates the item is a URL type media object."
        }
    },
    "description":"MediaObjectListItem is an individual media object within the response returned from the list operation."
}

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

• Array of: string

{
    "type":"array",
    "description":"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.",
    "items":{
        "type":"string"
    }
}

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

Body ()

Root Schema : ServiceErrorResponse

Type: object

Error Response

Show Source

• errorText(optional): string
• exception(optional): string
  The class of the exception if an exception was thrown.
• exceptionId(optional): string
  ExceptionId, only if an exception record was written to the F980060
• message(optional): string
  Details about the error.
• status(optional): string
  Allowed Values: [ "ERROR", "WARNING" ]

  Status determined by exception handling
• timeStamp(optional): string
  The timestamp indicating the time the error message was returned.
• type(optional): string
  Optional type of error
• userDefinedErrorText(optional): string
  Optional error text added to an orchestration step.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

500 Response

Server Failed to Process Request

Body ()

Root Schema : ServiceErrorResponse

Type: object

Error Response

Show Source

• errorText(optional): string
• exception(optional): string
  The class of the exception if an exception was thrown.
• exceptionId(optional): string
  ExceptionId, only if an exception record was written to the F980060
• message(optional): string
  Details about the error.
• status(optional): string
  Allowed Values: [ "ERROR", "WARNING" ]

  Status determined by exception handling
• timeStamp(optional): string
  The timestamp indicating the time the error message was returned.
• type(optional): string
  Optional type of error
• userDefinedErrorText(optional): string
  Optional error text added to an orchestration step.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

Back to Top

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
}

Back to Top