1. REST API for JD Edwards EnterpriseOne AIS Server
  2. Tasks
  3. Media Object Service

Update Text Attachment v2

post

/v2/file/updatetext

Update the text of a text media object for a given structure, key, and sequence. If sequence is not provided, the first text media object will be updated.

Request

Supported Media Types
Header Parameters
Body ()
Request to a text media object with the input text.
Root Schema : MediaObjectUpdateTextRequestV2
Type: object
Request to a text media object with the input text.
Show Source
  • When appending text the default behavior will add a line before each append (true). To omit the additional line pass false.
  • Indicates if the text sent should be appended to existing text (true), or replace it (false).
  • An identifier for the device making the service call. If not provided, the requesting IP address is used.
  • Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
  • The name of the form the media object is associated with (for example W01012A).
  • The text to be updated to the first text media object for the structure and key.
  • If a value is sent, the name of the text item will be updated with the value sent.
  • The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
  • 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.
  • The media object data structure name, for example GT0801 or ABGT, which is a key to the F00165 table where media objects are stored.
  • The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
  • Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
  • The role to use for login. If not specified, the default role configured for the AIS Server will be used.
  • The sequence number of the text item to update. A value of zero is the default and will update the first text item.
  • The AIS token, which is required if other authentication methods are not being used.
  • JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.
  • 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
Back to Top

Response

Supported Media Types

200 Response

Successful Execution
Body ()
Root Schema : MediaObjectListResponse
Type: object
MediaObjectListResponse is the output of the media object list operation.
Show Source
Nested Schema : mediaObjects
Type: array
The list of media object items.
Show Source
Nested Schema : MediaObjectListItem
Type: object
MediaObjectListItem is an individual media object within the response returned from the list operation.
Show Source
  • 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.
  • An identifier for the device making the service call. If not provided, the requesting IP address is used.
  • For file type media objects this is the download URL needed ot download the item. Pass this value into a download request.
  • Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
  • The location of the file for this media object.
  • The name of the form the media object is associated with (for example W01012A).
  • Indicates that this image was set as the default image for this media object structure and key.
  • Indicates the file is an image.
  • Indicates the item is an OLE item.
  • Indicates the item is a shortcut.
  • Indicates the item is a text type media object.
  • Indicates the item has been updated.
  • Indicates the item is a URL type media object.
  • The name of the media object item.
  • The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
  • 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.
  • The media object data structure name, for example GT0801 or ABGT, which is a key to the F00165 table where media objects are stored.
  • The media object type, 0-Text, 1-File, 5-URL.
  • The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
  • Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
  • If the file was from the media object queue, the queue name will be returned.
  • The role to use for login. If not specified, the default role configured for the AIS Server will be used.
  • The sequence number of the media object item.
  • The AIS token, which is required if other authentication methods are not being used.
  • The date the media object was last updated.
  • The hour of the day the item was last updated.
  • The minute of the hour of the day the item was last updated.
  • The second of the minute of the hour day the item was last updated.
  • The user that last updated the item.
  • JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.
  • 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
Body ()
Root Schema : ServiceErrorResponse
Type: object
Error Response
Show Source

500 Response

Server Failed to Process Request
Body ()
Root Schema : ServiceErrorResponse
Type: object
Error Response
Show Source
Back to Top

Examples

Example Request - First Text

The following shows an example of a media object request to update the first text media object. This service updates (or creates) the first text media object based on the key. You may indicate if the new text should append or overwrite the existing text. The token passed in this example was received from a separate token request.


curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/v2/file/updatetext -d
{
    "token": "0444WnTJVRGpnlwN4OCRXY9Q3m74QaYWYlNM0u3TUCVl+8=MDE5MDA4NjcwMzAwMTkzOTg3NDE1NzUyNE15RGV2aWNlMTQ4MDcwMjkzMjI1OQ==",
    "moStructure": "ABGT",
    "moKey": [
        "7500"
    ],
    "formName": "P01012_W01012B",
    "version": "ZJDE0001",
    "inputText": "Text from AIS Service Call.",
    "appendText": false
}

Example Response - First Text

The following example shows the contents of the response body.

{
    "updateTextStatus": "Success"
}

Example Request - By Sequence

The following shows an example of a media object request to update the text item at sequence 12. This example also indicates a request to overwrite the existing text (appendText is false).


curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/v2/file/updatetext -d
{
    "token": "0444WnTJVRGpnlwN4OCRXY9Q3m74QaYWYlNM0u3TUCVl+8=MDE5MDA4NjcwMzAwMTkzOTg3NDE1NzUyNE15RGV2aWNlMTQ4MDcwMjkzMjI1OQ==",     
    "moStructure": "ABGT",
    "moKey": [
        "7500"
    ],
    "sequence": 12,
    "appendText": false,
    "formName": "P01012_W01012B",
    "version": "ZJDE0001",
    "itemName": "Updated Name",
    "inputText": "Overwrite text in sequence 12.",
    "appendText": false
}

Example Response - By Sequence

The following example shows the contents of the response body.

{
    "updateTextStatus": "Success"
}

Example Response - Failure

The following example shows the contents of the response body in the case of failure. The cause could be that the text item for that sequence does not exist, or that the item for that sequence is not a text type media object.

{
   "error": "Invalid Sequence for Text Item: 15",
   "updateTextStatus": "Failure"
}
Back to Top