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

Get Text Attachment v2

post

/jderest/v2/file/gettext

Get text media objects for a given structure and key.

Request

Supported Media Types
Header Parameters
Body ()
Request text media objects based on structure, key, and sequence.
Root Schema : MediaObjectGetTextRequestV2
Type: object
Request text media objects based on structure, key, and sequence.
Show Source
  • 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).
  • When retriving HTML based text media objects indicate if response should include HTML tags (true) or convert to plain text (false). The default is false.
  • 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.
  • A value of true indicates that the service should return all text media objects in an array. If a sequence number is provided, it will return just the requested text item in the array.
  • 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 an individual text item being requested.
  • 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
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 get the first text media object based on the key. 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/gettext -d
{
    "token": "0440oeYB5hvl/zEsJvbJDUGRpPSK6kXSyoeiolMRcC6hrM=MDE5MDA4NDY4NzIwOTczNjY3MTg1OTA3OU15RGV2aWNlMTQ4MDcwMjYzNzcxMg==",
    "moStructure": "ABGT",
    "moKey": [
        "7500"
    ],
    "formName": "P01012_W01012B",
    "version": "ZJDE0001"
}

Example Response - First Text

The following example shows the contents of the response body.

{
  "ssoEnabled" : false,
  "text" : "Text media object contents.",
  "isRTF" : false
}

Example Request - All Text

The following shows an example of a media object request to get all text media objects based on the key. 


curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/v2/file/gettext -d
{
    "token": "0440oeYB5hvl/zEsJvbJDUGRpPSK6kXSyoeiolMRcC6hrM=MDE5MDA4NDY4NzIwOTczNjY3MTg1OTA3OU15RGV2aWNlMTQ4MDcwMjYzNzcxMg==",
    "moStructure": "ABGT",
    "moKey": [
        "7500"
    ],
    "multipleMode": true,
    "formName": "P01012_W01012B",
    "version": "ZJDE0001"
}

Example Response - All Text

The following example shows the contents of the response body.

{"textAttachments": [
      {
      "text": "Text 6 ? This is the First Text Object",
      "isRTF": false,
      "sequence": 6
      "itemName": "Text6"
   },
      {
      "text": "Text 8",
      "isRTF": false,
      "sequence": 8
      "itemName": "Test Text Item"
   },
      {
      "text": "Text 9",
      "isRTF": false,
      "sequence": 9
      "itemName": "Text9"
   }
]}

Example Request - Single By Sequence

The following shows an example of a media object request to get a single text media object based on the key and sequence. 


curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/v2/file/gettext -d
{
    "token": "0440oeYB5hvl/zEsJvbJDUGRpPSK6kXSyoeiolMRcC6hrM=MDE5MDA4NDY4NzIwOTczNjY3MTg1OTA3OU15RGV2aWNlMTQ4MDcwMjYzNzcxMg==",
    "moStructure": "ABGT",
    "moKey": [
        "7500"
    ],    
    "multipleMode": true,
    "sequence": 9,
    "formName": "P01012_W01012B",
    "version": "ZJDE0001"
}

Example Response - Single By Sequence

The following example shows the contents of the response body.

{"textAttachments": [      
      {
      "text": "Text 9",
      "isRTF": false,
      "sequence": 9
      "itemName": "Text9"
   }
]}
Back to Top