Get a resource action
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkResourceActions/{ResourceActionId}
Request
Path Parameters
-
ResourceActionId: integer
The unique identifier of the resource action.
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 : publicSectorBusinessRulesFrameworkResourceActions-item
Type:
Show Source
object
-
ActionCode(optional):
string
Maximum Length:
32
The code that can be used to reference this resource action. -
ActionDescription(optional):
string
Title:
Action Description
Maximum Length:256
The description of this resource action as it appears in the user interface. -
ActionEndpoint(optional):
string
Maximum Length:
1000
The REST endpoint provided for this resource action. -
ActionName(optional):
string
Title:
Action Name
Maximum Length:100
The name of this resource action as it appears in the user interface. -
AgencyId(optional):
integer(int32)
Title:
Agency Id
The unique identifier of the agency associated with the resource action. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the resource action. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the resource action was created. -
DeletedFlag(optional):
string
Maximum Length:
1
Indicates whether the record is logically deleted. Valid values are Y for deleted record and N for active record. The default value is N. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The user who last updated the resource action. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The date when the resource action was last updated. -
links(optional):
array Items
Title:
Items
Link Relations -
ModuleId(optional):
string
Maximum Length:
32
The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data. -
RequiredParameters(optional):
string
A field for storing the parameters required for this resource action.
-
ResourceActionId(optional):
integer(int64)
The unique identifier of the resource action.
-
ResourceId(optional):
integer(int64)
The unique identifier of the parent resource for this resource action.
-
SeedDataLock(optional):
integer(int32)
Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.
-
SeedDataSource(optional):
string
Maximum Length:
512
The source of the seed data record. A value of BULK_SEED_DATA_SCRIPT indicates that record was loaded in bulk. Otherwise, specifies the name of the seed data file.
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.