Create a communication event
post
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationEvents
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency associated with the communication event. -
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. -
EmEnabled: string
Maximum Length:
1
Default Value:N
Indicates whether the event is enabled for the event management framework. The default value is N. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the communication event is available to be used. The default value is N. -
EventCode: string
Title:
Event Code
Maximum Length:32
The communication event code. -
EventDescription: string
Title:
Description
Maximum Length:1000
The description of the communication event. -
EventId: integer
(int64)
Title:
Event ID
The unique identifier of the communication event. Automatically generated by the application. -
EventName: string
Title:
Event Name
Maximum Length:500
The name of the communication event. -
EventRunType: string
Maximum Length:
18
Indicates how an event is configured to run, such as synchronously, asynchronously, and so on. -
EventType: string
Title:
Event Type
Maximum Length:30
The type of communication event. -
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. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the communication resource. -
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.
Response
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 : publicSectorCommunicationEvents-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 event. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the communication event. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the communication event 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. -
EmEnabled: string
Maximum Length:
1
Default Value:N
Indicates whether the event is enabled for the event management framework. The default value is N. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Indicates whether the communication event is available to be used. The default value is N. -
EventCode: string
Title:
Event Code
Maximum Length:32
The communication event code. -
EventDescription: string
Title:
Description
Maximum Length:1000
The description of the communication event. -
EventId: integer
(int64)
Title:
Event ID
The unique identifier of the communication event. Automatically generated by the application. -
EventName: string
Title:
Event Name
Maximum Length:500
The name of the communication event. -
EventResourceName: string
Title:
Resource Name
Read Only:true
Maximum Length:100
Specifies a resource code which can be used to identify an event. -
EventRunType: string
Maximum Length:
18
Indicates how an event is configured to run, such as synchronously, asynchronously, and so on. -
EventType: string
Title:
Event Type
Maximum Length:30
The type of communication event. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the communication event was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the communication event. -
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
Read Only:
true
Maximum Length:80
The offering under which this resource falls. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the communication resource. -
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 : 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.