Get a feed event
get
/crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}
Request
Path Parameters
-
FeedEventId(required): string
The unique identifier of the feed event.
-
FeedId(required): string
The unique identifier of the feed.
-
FeedObjectId(required): string
The unique identifier of feed object.
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:
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.
Root Schema : feedConfigurations-FeedObject-FeedEvent-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active Status Indicator
Maximum Length:1
Default Value:true
The status of the event for generating the feed. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DeleteFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the user has access to delete the record. -
EventCode: string
Title:
Event Code
Maximum Length:30
The type of event for which the feed needs to be generated. -
FeedAttr: array
Feed Attributes
Title:
Feed Attributes
The feed attributes resource is used to create, update, and delete the attributes of the feed objects. -
FeedEventDetails: string
(byte)
Title:
Feed Event Details
This CLOB field contains additional information of JSON. -
FeedEventId: string
Title:
Feed Event ID
Maximum Length:64
The unique identifier of the feed event. -
FeedObjectId: string
Title:
Feed Object ID
Maximum Length:64
The unique identifier of the feed object. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SignalDefId: string
Title:
Signal Definition ID
Maximum Length:64
The identifier for signal definition that is generated by signals. -
UpdateFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the user has access to update the record.
Nested Schema : Feed Attributes
Type:
array
Title:
Feed Attributes
The feed attributes resource is used to create, update, and delete the attributes of the feed objects.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : feedConfigurations-FeedObject-FeedEvent-FeedAttr-item-response
Type:
Show Source
object
-
AttributeName: string
Title:
Attribute Name
Maximum Length:100
The name of the attribute of the feed object. -
ChangeIndicatorFlag: boolean
Title:
Change Indicator
Maximum Length:1
Default Value:false
The change indicator that denotes when an attribute is updated and the signal is generated. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DeleteFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the user has access to delete the record. -
DisplayFlag: boolean
Maximum Length:
1
Default Value:true
The flag indicates if the field is an internal attribute -
FeedAttrDetails: string
(byte)
Title:
Feed Attribute Details
The CLOB that contains additional information of JSON. -
FeedAttributeId: string
Title:
Feed Attribute ID
Maximum Length:64
The unique identifier for attribute of the feed object. -
FeedEventId: string
Title:
Feed Event ID
Maximum Length:64
The name of the attribute of the feed object. -
FeedObjectId: string
Title:
Feed Object ID
Maximum Length:64
The unique identifier for feed object. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayloadFlag: boolean
Title:
Payload Indicator
Maximum Length:1
Default Value:true
The JSON-formatted text of the web service. -
SortFlag: boolean
Maximum Length:
1
The flag indicates if the field can be sorted. -
UpdateFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the user has access to update the record.
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.
Links
- FeedAttr
-
Parameters:
- FeedEventId:
$request.path.FeedEventId
- FeedId:
$request.path.FeedId
- FeedObjectId:
$request.path.FeedObjectId
The feed attributes resource is used to create, update, and delete the attributes of the feed objects. - FeedEventId: