Update an ad hoc alert
patch
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts/{LogId}
Request
Path Parameters
-
LogId(required): integer(int64)
A logical identifier for the ad hoc alert. This ID is automatically generated by the application.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency associated with the ad hoc alert. -
Alertbody: string
Title:
Body
Maximum Length:1000
The message body of the ad hoc alert. -
AlertEnd: string
(date-time)
Title:
Alert End Date
The date and time when the ad hoc alert is no longer active. -
AlertStart: string
(date-time)
Title:
Alert Start Date
The date and time when the ad hoc alert becomes active. -
Comments: string
Title:
Comments
Maximum Length:1000
The comments entered by staff while creating the ad hoc alert. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:false
Indicates whether the ad hoc alert is available to be used. The default value is N. -
RecordIdentifier: string
Title:
Record Identifier
Maximum Length:100
The unique identifier of the ad hoc alert. -
SourceDescription: string
Maximum Length:
500
The event name for which the communication has been triggered. -
Status: string
Title:
Status
Maximum Length:30
Status of the ad hoc alert. -
ToAddress: string
Title:
Sent To
Maximum Length:1000
The type of the recipient for the ad hoc alert. Possible values are Registered Users, Anonymous Users, and Specified Users.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorAdhocAlerts-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency associated with the ad hoc alert. -
Alertbody: string
Title:
Body
Maximum Length:1000
The message body of the ad hoc alert. -
AlertEnd: string
(date-time)
Title:
Alert End Date
The date and time when the ad hoc alert is no longer active. -
AlertStart: string
(date-time)
Title:
Alert Start Date
The date and time when the ad hoc alert becomes active. -
Comments: string
Title:
Comments
Maximum Length:1000
The comments entered by staff while creating the ad hoc alert. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the ad hoc alert. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the ad hoc alert was created. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:false
Indicates whether the ad hoc alert is available to be used. The default value is N. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the ad hoc alert was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who updated the ad hoc alert most recently. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LogId: integer
(int64)
Title:
Log ID
A logical identifier for the ad hoc alert. This ID is automatically generated by the application. -
RecordIdentifier: string
Title:
Record Identifier
Maximum Length:100
The unique identifier of the ad hoc alert. -
SourceDescription: string
Maximum Length:
500
The event name for which the communication has been triggered. -
Status: string
Title:
Status
Maximum Length:30
Status of the ad hoc alert. -
Subject: string
Title:
Subject
Read Only:true
The summary of the ad hoc alert message body. -
ToAddress: string
Title:
Sent To
Maximum Length:1000
The type of the recipient for the ad hoc alert. Possible values are Registered Users, Anonymous Users, and Specified Users.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.