Get an ad hoc text
get
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts/{LogId}
Request
Path Parameters
-
LogId: integer
The unique identifier for the communication ad hoc text. This ID is automatically generated by the application.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.