Download as txt, pdf, or txt
Download as txt, pdf, or txt
You are on page 1of 2

Update Text Attachment v1

POST
/jderest/file/updatetext

Update the text of the given text media object.

Request
Supported Media Types
application/json
Header Parameters
jde-AIS-Auth(optional): string
jde-AIS-Auth-Device(optional): string
Body (MediaObjectUpdateTextRequest)
Request to update the first text media object with the input text.
Type: object
Request to update the first text media object with the input text.
appendText(optional): boolean
deviceName(optional): string
environment(optional): string
formName: string
inputText: string
jasserver(optional): string
moKey: array
moStructure: string
password(optional): string
psToken(optional): string
role(optional): string
token(optional): string
username(optional): string
version: stringBack to Top
Response
Supported Media Types
application/json
200 Response
Successful Execution
Body (MediaObjectUpdateTextResponse)
Type: object
Response to service request to update media object text.
updateTextStatus(optional): 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 (ServiceErrorResponse)
Type: object
Error Response
errorText(optional): string
exception(optional): string
message(optional): string
timeStamp(optional): string
type(optional): string
userDefinedErrorText(optional): string
500 Response
Server Failed to Process Request
Body (ServiceErrorResponse)
Type: object
Error Response
errorText(optional): string
exception(optional): string
message(optional): string
timeStamp(optional): string
type(optional): string
userDefinedErrorText(optional): stringBack to Top
Examples
Example Request

The following shows an example of a media object request to update a 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/file/updatetext -d
{
"token":
"0444WnTJVRGpnlwN4OCRXY9Q3m74QaYWYlNM0u3TUCVl+8=MDE5MDA4NjcwMzAwMTkzOTg3NDE1NzUyNE1
5RGV2aWNlMTQ4MDcwMjkzMjI1OQ==",
"moStructure": "ABGT",
"moKey": [
"7500"
],
"formName": "P01012_W01012B",
"version": "ZJDE0001",
"inputText": "Text from AIS Service Call.",
"appendText": false
}

Example Response

The following example shows the contents of the response body.

{
"updateTextStatus": "Success"
}

You might also like