Get all communication resources
get
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources
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 resource that matches the specified primary key criteria.
Finder Variables:- ResourceId; integer; The unique identifier of the communication resource.
- ResourceCodeAltKey: Finds a communication resource that matches the specified alternate key criteria.
Finder Variables:- ResourceCode; string; The unique code for the communication resource.
- simpleSearchFinder: Finds a communication resource with the specified key word.
Finder Variables:- value; string; The key word used to find a communication resource such as resource name or resource path.
- PrimaryKey: Finds a communication resource that matches the specified primary key criteria.
-
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 resource.
- CreatedBy; string; The user who created the communication resource.
- CreationDate; string; The date and time that the communication resource was created.
- DeletedFlag; string; Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
- Description; string; The description for the communication resource.
- EmEnabled; string; Indicates whether the resource is enabled for use in the business rules framework. The default value is N.
- EnabledFlag; string; Indicates whether the communication resource is available to be used. The default value is false.
- LastUpdateDate; string; The date that the communication resource was last updated.
- LastUpdatedBy; string; The user who last updated the communication resource.
- ModuleId; string; The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
- OfferingId; string; The offering under which this resource is categorized.
- ResourceCode; string; The unique code for the communication resource.
- ResourceId; integer; The unique identifier of the communication resource. This ID is automatically generated by the application.
- ResourceName; string; The name of the communication resource.
- ResourcePath; string; The communication resource REST endpoint name.
- SeedDataLock; integer; Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
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 : publicSectorCommunicationResources
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 : publicSectorCommunicationResources-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency associated with the communication resource. -
CommResourceRelations: array
Communication Related Resources
Title:
Communication Related Resources
The communications related resources resource is used to view the established relationship between an anchor resource and a related resource. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the communication resource. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the communication resource was created. -
DeletedFlag: string
Maximum Length:
1
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
Description: string
Title:
Description
Maximum Length:256
The description for the communication resource. -
EmEnabled: string
Maximum Length:
1
Default Value:N
Indicates whether the resource is enabled for use in the business rules framework. The default value is N. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the communication resource is available to be used. The default value is false. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date that the communication resource was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the communication resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModuleId: string
Maximum Length:
32
The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data. -
OfferingId: string
Maximum Length:
80
The offering under which this resource is categorized. -
ResourceCode: string
Title:
Resource Code
Maximum Length:32
The unique code for the communication resource. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the communication resource. This ID is automatically generated by the application. -
ResourceName: string
Title:
Resource Name
Maximum Length:100
The name of the communication resource. -
ResourcePath: string
Title:
Resource Endpoint
Maximum Length:1000
The communication resource REST endpoint name. -
SeedDataLock: integer
(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
Nested Schema : Communication Related Resources
Type:
array
Title:
Communication Related Resources
The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorCommunicationResources-CommResourceRelations-item-response
Type:
Show Source
object
-
AnchorFifthKeyName: string
Maximum Length:
100
The fifth key name of the anchor communication resource. -
AnchorFirstKeyName: string
Maximum Length:
100
The first key name of the anchor communication resource. -
AnchorFourthKeyName: string
Maximum Length:
100
The fourth key name of the anchor communication resource. -
AnchorResourceCode: string
Title:
Resource Code
Read Only:true
Maximum Length:32
The anchor resource code. -
AnchorResourceId: integer
(int64)
The anchor resource identifier.
-
AnchorSecondKeyName: string
Maximum Length:
100
The second key name of the anchor communication resource. -
AnchorThirdKeyName: string
Maximum Length:
100
The third key name of the anchor communication resource. -
ContactTypeResFlag: string
Maximum Length:
1
Indicates whether the resource relation is based on the contact type. If the value is Y, the resource relation is contact type based. The default value is N. -
DeletedFlag: string
Maximum Length:
1
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModuleId: string
Maximum Length:
32
The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data. -
RelatedFifthKeyName: string
Maximum Length:
100
The fifth key name of the related communication resource. -
RelatedFirstKeyName: string
Maximum Length:
100
The first key name of the related communication resource. -
RelatedFourthKeyName: string
Maximum Length:
100
The fourth key name of the related communication resource. -
RelatedResourceCode: string
Title:
Resource Code
Read Only:true
Maximum Length:32
The related resource code. -
RelatedResourceId: integer
(int64)
The related resource identifier.
-
RelatedSecondKeyName: string
Maximum Length:
100
The second key name of the related communication resource. -
RelatedThirdKeyName: string
Maximum Length:
100
The third key name of the related communication resource. -
ResourceRelationCode: string
Maximum Length:
100
The unique code for the related communication resource. -
ResourceRelationId: integer
(int64)
The unique identifier for the related communication resource. This is automatically generated by the application.
-
SeedDataLock: integer
(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
SeedDataSource: string
Maximum Length:
512
Indicates the source of the seed data.
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.