Get an event
get
/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkEvents/{EventId}
Request
Path Parameters
-
EventId(required): integer(int64)
The unique identifier of the event. The ID is automatically generated by the application.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorBusinessRulesFrameworkEvents-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with the resource action. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the event was created. -
DeletedFlag: 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. -
EmEnabled: string
Maximum Length:
1
Default Value:N
Indicates whether the event is enabled for the business rules framework. The default value is N. -
EnabledFlag: string
Maximum Length:
1
Indicates whether the event is available to be used in communication service. The default value is N. -
EventCode: string
Title:
Event Code
Maximum Length:32
The event code. -
EventDescription: string
Title:
Event Description
Maximum Length:1000
The description of the event. -
EventId: integer
(int64)
The unique identifier of the event. The ID is automatically generated by the application.
-
EventName: string
Title:
Event Name
Maximum Length:500
The name of the event. -
EventType: string
Maximum Length:
30
The type of event. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the event. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModuleId: 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. -
OfferingId: string
Maximum Length:
80
The offering under which this event is categorized. -
ResourceCode: string
Read Only:
true
Maximum Length:32
The unique identifier for the resource for the event. -
ResourceDeletedFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the resource can be or has been deleted. -
ResourceDescription: string
Title:
Resource Description
Read Only:true
Maximum Length:256
Provides a description of the resource for the event. -
ResourceEmEnabled: string
Maximum Length:
1
Default Value:N
Indicates whether the parent resource is enabled for use in the business rules framework. The default value is N. -
ResourceId: integer
(int64)
The unique identifier of the parent resource for this resource action.
-
ResourceName: string
Title:
Business Object
Maximum Length:100
The name of the parent resource. -
ResourcePath: string
Read Only:
true
Maximum Length:1000
The path for accesing the resource for the event. -
SeedDataLock: 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.
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.