Get all communication requests
get
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRequests
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 a communication request with the specified log ID.
Finder Variables:- LogId; integer; The unique identifier of the communication request log.
- PrimaryKey: Finds a communication request with the specified log ID.
-
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 communication request.
- ApplicationAddress1; string; The Application Address Line 1 for Business Entity Location.
- ApplicationAddress2; string; The Application Address Line 2 for Business Entity Location.
- ApplicationAddress3; string; The Application Address Line 3 for Business Entity Location.
- ApplicationAddress4; string; The Application Address Line 4 for Business Entity Location.
- ApplicationCity; string; The Application City Name for Business Entity Location.
- ApplicationCountry; string; The Application Country Name for Business Entity Location.
- ApplicationCounty; string; The Application County Name for Business Entity Location.
- ApplicationDbaBusinessName; string; Doing Business As name for Business Entity Location.
- ApplicationOrganizationName; string; Organization Name for Business Entity Location.
- ApplicationPostal; string; Postal code for Business Entity Location.
- ApplicationState; string; State name for Business Entity Location.
- CreatedBy; string; The user who created the communication request.
- CreationDate; string; The date and time that the communication message was created.
- Email; boolean; Indicates that the communication request uses the email channel type.
- EventCode; string; The unique identifier for the communication event.
- LastUpdateDate; string; The user who last updated the communication request.
- LastUpdatedBy; string; The date that the communication request was last updated.
- LogId; integer; The unique identifier of the communication request log. This ID is generated automatically by the application.
- LogMsgAttData; string; The attachment details attached to the communication.
- Notification; boolean; Indicates that the communication request uses the notification channel type.
- RecordFifthKeyId; string; The fifth key id name of the communication resource associated with the event.
- RecordFifthKeyName; string; The fifth key name of the communication resource associated with the event.
- RecordFifthKeyValue; string; The fifth key value of the communication resource associated with the event.
- RecordFirstKeyId; string; The first key id name of the communication resource associated with the event.
- RecordFirstKeyName; string; The first key name of the communication resource associated with the event.
- RecordFirstKeyValue; string; The first key value of the communication resource associated with the event.
- RecordFourthKeyId; string; The fourth key id name of the communication resource associated with the event.
- RecordFourthKeyName; string; The fourth key name of the communication resource associated with the event.
- RecordFourthKeyValue; string; The fourth key value of the communication resource associated with the event.
- RecordIdentifier; string; The communication request identifier passed through the communication request.
- RecordSecondKeyId; string; The second key id name of the communication resource associated with the event.
- RecordSecondKeyName; string; The second key name of the communication resource associated with the event.
- RecordSecondKeyValue; string; The second key value of the communication resource associated with the event.
- RecordSubIdentifier; string; The communication request sub identifier passed through the communication request.
- RecordThirdKeyId; string; The third key id name of the communication resource associated with the event.
- RecordThirdKeyName; string; The third key name of the communication resource associated with the event.
- RecordThirdKeyValue; string; The third key value of the communication resource associated with the event.
- SourceDescription; string; The event name for which the communication is triggered.
- Status; string; The status of the communication message.
- TemplateCode; string; The unique identifier for the communication template associated with the communication request.
- Text; boolean; Indicates that the communication request uses the text channel type.
-
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 : publicSectorCommunicationRequests
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 : publicSectorCommunicationRequests-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with the communication request. -
ApplicationAddress1: string
Title:
Application Address 1
Maximum Length:240
The Application Address Line 1 for Business Entity Location. -
ApplicationAddress2: string
Title:
Application Address 2
Maximum Length:240
The Application Address Line 2 for Business Entity Location. -
ApplicationAddress3: string
Title:
Application Address 3
Maximum Length:240
The Application Address Line 3 for Business Entity Location. -
ApplicationAddress4: string
Title:
Application Address 4
Maximum Length:240
The Application Address Line 4 for Business Entity Location. -
ApplicationCity: string
Title:
Application City
Maximum Length:60
The Application City Name for Business Entity Location. -
ApplicationCountry: string
Title:
Application Country
Maximum Length:3
The Application Country Name for Business Entity Location. -
ApplicationCounty: string
Title:
Application County
Maximum Length:20
The Application County Name for Business Entity Location. -
ApplicationDbaBusinessName: string
Title:
Doing Business As
Maximum Length:360
Doing Business As name for Business Entity Location. -
ApplicationOrganizationName: string
Title:
Organization Name
Maximum Length:360
Organization Name for Business Entity Location. -
ApplicationPostal: string
Title:
Application Postal Code
Maximum Length:60
Postal code for Business Entity Location. -
ApplicationState: string
Title:
Application State
Maximum Length:60
State name for Business Entity Location. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the communication request. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the communication message was created. -
Email: boolean
Default Value:
false
Indicates that the communication request uses the email channel type. -
EventCode: string
The unique identifier for the communication event.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The user who last updated the communication request. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The date that the communication request was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Log: string
(byte)
The communication request error details.
-
LogId: integer
(int64)
Title:
Log ID
The unique identifier of the communication request log. This ID is generated automatically by the application. -
LogMsgAttData: string
The attachment details attached to the communication.
-
Notification: boolean
Default Value:
false
Indicates that the communication request uses the notification channel type. -
RecordFifthKeyId: string
Title:
Record Fifth Key ID
Maximum Length:100
The fifth key id name of the communication resource associated with the event. -
RecordFifthKeyName: string
Title:
Record Fifth Key Name
Maximum Length:32
The fifth key name of the communication resource associated with the event. -
RecordFifthKeyValue: string
Title:
Record Fifth Key Value
Maximum Length:100
The fifth key value of the communication resource associated with the event. -
RecordFirstKeyId: string
Title:
Record First Key ID
Maximum Length:100
The first key id name of the communication resource associated with the event. -
RecordFirstKeyName: string
Title:
Record First Key Name
Maximum Length:32
The first key name of the communication resource associated with the event. -
RecordFirstKeyValue: string
Title:
Record First Key Value
Maximum Length:100
The first key value of the communication resource associated with the event. -
RecordFourthKeyId: string
Title:
Record Fourth Key ID
Maximum Length:100
The fourth key id name of the communication resource associated with the event. -
RecordFourthKeyName: string
Title:
Record Fourth Key Name
Maximum Length:32
The fourth key name of the communication resource associated with the event. -
RecordFourthKeyValue: string
Title:
Record Fourth Key Value
Maximum Length:100
The fourth key value of the communication resource associated with the event. -
RecordIdentifier: string
Title:
Record Identifier
Maximum Length:100
The communication request identifier passed through the communication request. -
RecordSecondKeyId: string
Title:
Record Second Key ID
Maximum Length:100
The second key id name of the communication resource associated with the event. -
RecordSecondKeyName: string
Title:
Record Second Key Name
Maximum Length:32
The second key name of the communication resource associated with the event. -
RecordSecondKeyValue: string
Title:
Record Second Key Value
Maximum Length:100
The second key value of the communication resource associated with the event. -
RecordSubIdentifier: string
Title:
Record Subidentifier
Maximum Length:100
The communication request sub identifier passed through the communication request. -
RecordThirdKeyId: string
Title:
Record Third Key ID
Maximum Length:100
The third key id name of the communication resource associated with the event. -
RecordThirdKeyName: string
Title:
Record Third Key Name
Maximum Length:32
The third key name of the communication resource associated with the event. -
RecordThirdKeyValue: string
Title:
Record Third Key Value
Maximum Length:100
The third key value of the communication resource associated with the event. -
SourceDescription: string
Title:
Event Name
Maximum Length:500
The event name for which the communication is triggered. -
Status: string
Title:
Status
Maximum Length:30
Default Value:ORA_I
The status of the communication message. -
TemplateCode: string
The unique identifier for the communication template associated with the communication request.
-
Text: boolean
Default Value:
false
Indicates that the communication request uses the text channel type.
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.