Jump to

• Request
• Response

Update an ad hoc text

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts/{LogId}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• LogId: integer
  The unique identifier for the communication ad hoc text. This ID is automatically generated by the application.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorAdhocTexts-item

Type: object

Show Source

• 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)
  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)
  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
  Maximum Length: 32

  The fifth key name of the communication resource associated with the event.
• RecordFifthKeyValue(optional): string
  Maximum Length: 100

  The fifth key value of the communication resource associated with the event.
• RecordFirstKeyName(optional): string
  Maximum Length: 32

  The first key name of the communication resource associated with the event.
• RecordFirstKeyValue(optional): string
  Maximum Length: 100

  The first key value of the communication resource associated with the event.
• RecordFourthKeyName(optional): string
  Maximum Length: 32

  The fourth key name of the communication resource associated with the event.
• RecordFourthKeyValue(optional): string
  Maximum Length: 100

  The fourth key value of the communication resource associated with the event.
• RecordIdentifier(optional): string
  Maximum Length: 100

  The communication request identifier passed through the communication request.
• RecordSecondKeyName(optional): string
  Maximum Length: 32

  The second key name of the communication resource associated with the event.
• RecordSecondKeyValue(optional): string
  Maximum Length: 100

  The second key value of the communication resource associated with the event.
• RecordSubIdentifier(optional): string
  Maximum Length: 100

  The communication request sub identifier passed through the communication request.
• RecordThirdKeyName(optional): string
  Maximum Length: 32

  The third key name of the communication resource associated with the event.
• RecordThirdKeyValue(optional): string
  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
  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.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "description":"The unique identifier of the agency associated with the ad hoc text.",
            "type":"integer",
            "format":"int32"
        },
        "Body":{
            "description":"The body of the ad hoc text.",
            "type":"string"
        },
        "CreatedBy":{
            "description":"The user who created the ad hoc text request.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time that the ad hoc text request was created.",
            "type":"string",
            "format":"date-time"
        },
        "EventId":{
            "description":"The unique identifier for the communication event.",
            "type":"integer",
            "format":"int64"
        },
        "FromAddress":{
            "description":"The sender phone number of the ad hoc text.",
            "type":"string"
        },
        "LastUpdateDate":{
            "description":"The date that the ad hoc text request was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the communication ad hoc email request.",
            "type":"string",
            "maxLength":64
        },
        "Log":{
            "description":"The communication ad hoc text request error details.",
            "type":"string"
        },
        "LogId":{
            "description":"The unique identifier for the communication ad hoc text. This ID is automatically generated by the application.",
            "type":"integer",
            "format":"int64"
        },
        "PayloadData":{
            "description":"The data payload provided with the ad hoc text request.",
            "type":"string"
        },
        "PreferredLanguage":{
            "description":"The language used for the text message.",
            "type":"string"
        },
        "RecordFifthKeyName":{
            "description":"The fifth key name of the communication resource associated with the event.",
            "type":"string",
            "maxLength":32
        },
        "RecordFifthKeyValue":{
            "description":"The fifth key value of the communication resource associated with the event.",
            "type":"string",
            "maxLength":100
        },
        "RecordFirstKeyName":{
            "description":"The first key name of the communication resource associated with the event.",
            "type":"string",
            "maxLength":32
        },
        "RecordFirstKeyValue":{
            "description":"The first key value of the communication resource associated with the event.",
            "type":"string",
            "maxLength":100
        },
        "RecordFourthKeyName":{
            "description":"The fourth key name of the communication resource associated with the event.",
            "type":"string",
            "maxLength":32
        },
        "RecordFourthKeyValue":{
            "description":"The fourth key value of the communication resource associated with the event.",
            "type":"string",
            "maxLength":100
        },
        "RecordIdentifier":{
            "description":"The communication request identifier passed through the communication request.",
            "type":"string",
            "maxLength":100
        },
        "RecordSecondKeyName":{
            "description":"The second key name of the communication resource associated with the event.",
            "type":"string",
            "maxLength":32
        },
        "RecordSecondKeyValue":{
            "description":"The second key value of the communication resource associated with the event.",
            "type":"string",
            "maxLength":100
        },
        "RecordSubIdentifier":{
            "description":"The communication request sub identifier passed through the communication request.",
            "type":"string",
            "maxLength":100
        },
        "RecordThirdKeyName":{
            "description":"The third key name of the communication resource associated with the event.",
            "type":"string",
            "maxLength":32
        },
        "RecordThirdKeyValue":{
            "description":"The third key value of the communication resource associated with the event.",
            "type":"string",
            "maxLength":100
        },
        "ResourceEndPoint":{
            "description":"The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc text.",
            "type":"string"
        },
        "Status":{
            "description":"The status of the ad hoc text request.",
            "type":"string",
            "maxLength":30
        },
        "ToAddress":{
            "description":"The phone numbers of the ad hoc text recipients.",
            "type":"string"
        },
        "Visibility":{
            "description":"The visibility option of the triggered ad hoc text.",
            "type":"string"
        },
        "WebFormData":{
            "description":"The web form details attached to the text.",
            "type":"string"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorAdhocTexts-item

Type: object

Show Source

• 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)
  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)
  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
  Maximum Length: 32

  The fifth key name of the communication resource associated with the event.
• RecordFifthKeyValue(optional): string
  Maximum Length: 100

  The fifth key value of the communication resource associated with the event.
• RecordFirstKeyName(optional): string
  Maximum Length: 32

  The first key name of the communication resource associated with the event.
• RecordFirstKeyValue(optional): string
  Maximum Length: 100

  The first key value of the communication resource associated with the event.
• RecordFourthKeyName(optional): string
  Maximum Length: 32

  The fourth key name of the communication resource associated with the event.
• RecordFourthKeyValue(optional): string
  Maximum Length: 100

  The fourth key value of the communication resource associated with the event.
• RecordIdentifier(optional): string
  Maximum Length: 100

  The communication request identifier passed through the communication request.
• RecordSecondKeyName(optional): string
  Maximum Length: 32

  The second key name of the communication resource associated with the event.
• RecordSecondKeyValue(optional): string
  Maximum Length: 100

  The second key value of the communication resource associated with the event.
• RecordSubIdentifier(optional): string
  Maximum Length: 100

  The communication request sub identifier passed through the communication request.
• RecordThirdKeyName(optional): string
  Maximum Length: 32

  The third key name of the communication resource associated with the event.
• RecordThirdKeyValue(optional): string
  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
  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.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "description":"The unique identifier of the agency associated with the ad hoc text.",
            "type":"integer",
            "format":"int32"
        },
        "Body":{
            "description":"The body of the ad hoc text.",
            "type":"string"
        },
        "CreatedBy":{
            "description":"The user who created the ad hoc text request.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"The date and time that the ad hoc text request was created.",
            "type":"string",
            "format":"date-time"
        },
        "EventId":{
            "description":"The unique identifier for the communication event.",
            "type":"integer",
            "format":"int64"
        },
        "FromAddress":{
            "description":"The sender phone number of the ad hoc text.",
            "type":"string"
        },
        "LastUpdateDate":{
            "description":"The date that the ad hoc text request was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"The user who last updated the communication ad hoc email request.",
            "type":"string",
            "maxLength":64
        },
        "Log":{
            "description":"The communication ad hoc text request error details.",
            "type":"string"
        },
        "LogId":{
            "description":"The unique identifier for the communication ad hoc text. This ID is automatically generated by the application.",
            "type":"integer",
            "format":"int64"
        },
        "PayloadData":{
            "description":"The data payload provided with the ad hoc text request.",
            "type":"string"
        },
        "PreferredLanguage":{
            "description":"The language used for the text message.",
            "type":"string"
        },
        "RecordFifthKeyName":{
            "description":"The fifth key name of the communication resource associated with the event.",
            "type":"string",
            "maxLength":32
        },
        "RecordFifthKeyValue":{
            "description":"The fifth key value of the communication resource associated with the event.",
            "type":"string",
            "maxLength":100
        },
        "RecordFirstKeyName":{
            "description":"The first key name of the communication resource associated with the event.",
            "type":"string",
            "maxLength":32
        },
        "RecordFirstKeyValue":{
            "description":"The first key value of the communication resource associated with the event.",
            "type":"string",
            "maxLength":100
        },
        "RecordFourthKeyName":{
            "description":"The fourth key name of the communication resource associated with the event.",
            "type":"string",
            "maxLength":32
        },
        "RecordFourthKeyValue":{
            "description":"The fourth key value of the communication resource associated with the event.",
            "type":"string",
            "maxLength":100
        },
        "RecordIdentifier":{
            "description":"The communication request identifier passed through the communication request.",
            "type":"string",
            "maxLength":100
        },
        "RecordSecondKeyName":{
            "description":"The second key name of the communication resource associated with the event.",
            "type":"string",
            "maxLength":32
        },
        "RecordSecondKeyValue":{
            "description":"The second key value of the communication resource associated with the event.",
            "type":"string",
            "maxLength":100
        },
        "RecordSubIdentifier":{
            "description":"The communication request sub identifier passed through the communication request.",
            "type":"string",
            "maxLength":100
        },
        "RecordThirdKeyName":{
            "description":"The third key name of the communication resource associated with the event.",
            "type":"string",
            "maxLength":32
        },
        "RecordThirdKeyValue":{
            "description":"The third key value of the communication resource associated with the event.",
            "type":"string",
            "maxLength":100
        },
        "ResourceEndPoint":{
            "description":"The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc text.",
            "type":"string"
        },
        "Status":{
            "description":"The status of the ad hoc text request.",
            "type":"string",
            "maxLength":30
        },
        "ToAddress":{
            "description":"The phone numbers of the ad hoc text recipients.",
            "type":"string"
        },
        "Visibility":{
            "description":"The visibility option of the triggered ad hoc text.",
            "type":"string"
        },
        "WebFormData":{
            "description":"The web form details attached to the text.",
            "type":"string"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top