Get all ad hoc alerts
get
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the ad hoc alert that matches the primary key criteria specified.
Finder Variables:- LogId; integer; The unique identifier for the ad hoc alert.
- simpleSearchFinder: Finds an ad hoc alert that matches the specified key word.
Finder Variables:- value; string; The key word used to find an ad hoc alert such as event code, event type, event name, or description.
- PrimaryKey: Finds the ad hoc alert that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The unique identifier of the agency associated with the ad hoc alert.
- AlertEnd; string; The date and time when the ad hoc alert is no longer active.
- AlertStart; string; The date and time when the ad hoc alert becomes active.
- Alertbody; string; The message body of the ad hoc alert.
- Comments; string; The comments entered by staff while creating the ad hoc alert.
- CreatedBy; string; The user who created the ad hoc alert.
- CreationDate; string; The date and time when the ad hoc alert was created.
- EnabledFlag; boolean; Indicates whether the ad hoc alert is available to be used. The default value is N.
- LastUpdateDate; string; The date when the ad hoc alert was last updated.
- LastUpdatedBy; string; The user who updated the ad hoc alert most recently.
- LogId; integer; A logical identifier for the ad hoc alert. This ID is automatically generated by the application.
- RecordIdentifier; string; The unique identifier of the ad hoc alert.
- SourceDescription; string; The event name for which the communication has been triggered.
- Status; string; Status of the ad hoc alert.
- Subject; string; The summary of the ad hoc alert message body.
- ToAddress; string; The type of the recipient for the ad hoc alert. Possible values are Registered Users, Anonymous Users, and Specified Users.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.