Create an ad hoc text
post
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorAdhocTexts-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the ad hoc text.
-
Body(optional):
string
The body of the ad hoc text.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the ad hoc text request. -
CreationDate(optional):
string(date-time)
The date and time that the ad hoc text request was created.
-
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress(optional):
string
The sender phone number of the ad hoc text.
-
LastUpdateDate(optional):
string(date-time)
The date that the ad hoc text request was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the communication ad hoc email request. -
links(optional):
array Items
Title:
Items
Link Relations -
Log(optional):
string
The communication ad hoc text request error details.
-
LogId(optional):
integer(int64)
Title:
Log ID
The unique identifier for the communication ad hoc text. This ID is automatically generated by the application. -
PayloadData(optional):
string
The data payload provided with the ad hoc text request.
-
PreferredLanguage(optional):
string
The language used for the text message.
-
RecordFifthKeyName(optional):
string
Title:
Record Fifth Key Name
Maximum Length:32
The fifth key name of the communication resource associated with the event. -
RecordFifthKeyValue(optional):
string
Title:
Record Fifth Key Value
Maximum Length:100
The fifth key value of the communication resource associated with the event. -
RecordFirstKeyName(optional):
string
Title:
Record First Key Name
Maximum Length:32
The first key name of the communication resource associated with the event. -
RecordFirstKeyValue(optional):
string
Title:
Record First Key Value
Maximum Length:100
The first key value of the communication resource associated with the event. -
RecordFourthKeyName(optional):
string
Title:
Record Fourth Key Name
Maximum Length:32
The fourth key name of the communication resource associated with the event. -
RecordFourthKeyValue(optional):
string
Title:
Record Fourth Key Value
Maximum Length:100
The fourth key value of the communication resource associated with the event. -
RecordIdentifier(optional):
string
Title:
Record Identifier
Maximum Length:100
The communication request identifier passed through the communication request. -
RecordSecondKeyName(optional):
string
Title:
Record Second Key Name
Maximum Length:32
The second key name of the communication resource associated with the event. -
RecordSecondKeyValue(optional):
string
Title:
Record Second Key Value
Maximum Length:100
The second key value of the communication resource associated with the event. -
RecordSubIdentifier(optional):
string
Title:
Record Sub Identifier
Maximum Length:100
The communication request sub identifier passed through the communication request. -
RecordThirdKeyName(optional):
string
Title:
Record Third Key Name
Maximum Length:32
The third key name of the communication resource associated with the event. -
RecordThirdKeyValue(optional):
string
Title:
Record Third Key Value
Maximum Length:100
The third key value of the communication resource associated with the event. -
ResourceEndPoint(optional):
string
The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc text.
-
Status(optional):
string
Title:
Status
Maximum Length:30
The status of the ad hoc text request. -
ToAddress(optional):
string
The phone numbers of the ad hoc text recipients.
-
Visibility(optional):
string
The visibility option of the triggered ad hoc text.
-
WebFormData(optional):
string
The web form details attached to the text.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorAdhocTexts-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the ad hoc text.
-
Body(optional):
string
The body of the ad hoc text.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the ad hoc text request. -
CreationDate(optional):
string(date-time)
The date and time that the ad hoc text request was created.
-
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress(optional):
string
The sender phone number of the ad hoc text.
-
LastUpdateDate(optional):
string(date-time)
The date that the ad hoc text request was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the communication ad hoc email request. -
links(optional):
array Items
Title:
Items
Link Relations -
Log(optional):
string
The communication ad hoc text request error details.
-
LogId(optional):
integer(int64)
Title:
Log ID
The unique identifier for the communication ad hoc text. This ID is automatically generated by the application. -
PayloadData(optional):
string
The data payload provided with the ad hoc text request.
-
PreferredLanguage(optional):
string
The language used for the text message.
-
RecordFifthKeyName(optional):
string
Title:
Record Fifth Key Name
Maximum Length:32
The fifth key name of the communication resource associated with the event. -
RecordFifthKeyValue(optional):
string
Title:
Record Fifth Key Value
Maximum Length:100
The fifth key value of the communication resource associated with the event. -
RecordFirstKeyName(optional):
string
Title:
Record First Key Name
Maximum Length:32
The first key name of the communication resource associated with the event. -
RecordFirstKeyValue(optional):
string
Title:
Record First Key Value
Maximum Length:100
The first key value of the communication resource associated with the event. -
RecordFourthKeyName(optional):
string
Title:
Record Fourth Key Name
Maximum Length:32
The fourth key name of the communication resource associated with the event. -
RecordFourthKeyValue(optional):
string
Title:
Record Fourth Key Value
Maximum Length:100
The fourth key value of the communication resource associated with the event. -
RecordIdentifier(optional):
string
Title:
Record Identifier
Maximum Length:100
The communication request identifier passed through the communication request. -
RecordSecondKeyName(optional):
string
Title:
Record Second Key Name
Maximum Length:32
The second key name of the communication resource associated with the event. -
RecordSecondKeyValue(optional):
string
Title:
Record Second Key Value
Maximum Length:100
The second key value of the communication resource associated with the event. -
RecordSubIdentifier(optional):
string
Title:
Record Sub Identifier
Maximum Length:100
The communication request sub identifier passed through the communication request. -
RecordThirdKeyName(optional):
string
Title:
Record Third Key Name
Maximum Length:32
The third key name of the communication resource associated with the event. -
RecordThirdKeyValue(optional):
string
Title:
Record Third Key Value
Maximum Length:100
The third key value of the communication resource associated with the event. -
ResourceEndPoint(optional):
string
The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc text.
-
Status(optional):
string
Title:
Status
Maximum Length:30
The status of the ad hoc text request. -
ToAddress(optional):
string
The phone numbers of the ad hoc text recipients.
-
Visibility(optional):
string
The visibility option of the triggered ad hoc text.
-
WebFormData(optional):
string
The web form details attached to the text.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.