Get a communication resource
get
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}
Request
Path Parameters
-
ResourceId: integer
The unique identifier of the communication resource. This ID is automatically generated by the application.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCommunicationResources-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the communication resource. -
CommResourceRelations(optional):
array Communication Related Resources
Title:
Communication Related Resources
The communication resources resource is used to create and view communication resources. A communication resource is a metadata definition of a REST resource used by applications to trigger communications. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the communication resource. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the communication resource was created. -
DeletedFlag(optional):
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(optional):
string
Title:
Description
Maximum Length:256
The description for the communication resource. -
EmEnabled(optional):
string
Maximum Length:
1
Indicates whether the resource is enabled for use in the business rules framework. The default value is N. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates whether the communication resource is available to be used. The default value is false. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date that the communication resource was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the communication resource. -
links(optional):
array Items
Title:
Items
Link Relations -
ModuleId(optional):
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(optional):
string
Maximum Length:
80
The offering under which this resource is categorized. -
ResourceCode(optional):
string
Title:
Resource Code
Maximum Length:32
The unique code for the communication resource. -
ResourceId(optional):
integer(int64)
Title:
Resource ID
The unique identifier of the communication resource. This ID is automatically generated by the application. -
ResourceName(optional):
string
Title:
Resource Name
Maximum Length:100
The name of the communication resource. -
ResourcePath(optional):
string
Title:
Resource Endpoint
Maximum Length:1000
The communication resource REST endpoint name. -
SeedDataLock(optional):
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 communication resources resource is used to create and view communication resources. A communication resource is a metadata definition of a REST resource used by applications to trigger communications.
Show Source
Nested Schema : publicSectorCommunicationResources-CommResourceRelations-item
Type:
Show Source
object
-
AnchorFifthKeyName(optional):
string
Maximum Length:
100
The fifth key name of the anchor communication resource. -
AnchorFirstKeyName(optional):
string
Maximum Length:
100
The first key name of the anchor communication resource. -
AnchorFourthKeyName(optional):
string
Maximum Length:
100
The fourth key name of the anchor communication resource. -
AnchorResourceCode(optional):
string
Title:
Resource Code
Maximum Length:32
The anchor resource code. -
AnchorResourceId(optional):
integer(int64)
The anchor resource identifier.
-
AnchorSecondKeyName(optional):
string
Maximum Length:
100
The second key name of the anchor communication resource. -
AnchorThirdKeyName(optional):
string
Maximum Length:
100
The third key name of the anchor communication resource. -
DeletedFlag(optional):
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(optional):
array Items
Title:
Items
Link Relations -
ModuleId(optional):
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(optional):
string
Maximum Length:
100
The fifth key name of the related communication resource. -
RelatedFirstKeyName(optional):
string
Maximum Length:
100
The first key name of the related communication resource. -
RelatedFourthKeyName(optional):
string
Maximum Length:
100
The fourth key name of the related communication resource. -
RelatedResourceCode(optional):
string
Title:
Resource Code
Maximum Length:32
The related resource code. -
RelatedResourceId(optional):
integer(int64)
The related resource identifier.
-
RelatedSecondKeyName(optional):
string
Maximum Length:
100
The second key name of the related communication resource. -
RelatedThirdKeyName(optional):
string
Maximum Length:
100
The third key name of the related communication resource. -
ResourceRelationCode(optional):
string
Maximum Length:
100
The unique code for the related communication resource. -
ResourceRelationId(optional):
integer(int64)
The unique identifier for the related communication resource. This is automatically generated by the application.
-
SeedDataLock(optional):
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(optional):
string
Maximum Length:
512
Indicates the source of the seed data.
Nested Schema : link
Type:
Show Source
object
-
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.