Update a communication event
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationEvents/{EventId}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
EventId: integer
The unique identifier of the communication event. Automatically generated by the application.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCommunicationEvents-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the communication event. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the communication event. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the communication event 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. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates whether the communication event is available to be used. The default value is N. -
EventCode(optional):
string
Title:
Event Code
Maximum Length:32
The communication event code. -
EventDescription(optional):
string
Title:
Description
Maximum Length:1000
The description of the communication event. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier of the communication event. Automatically generated by the application. -
EventName(optional):
string
Title:
Event Name
Maximum Length:500
The name of the communication event. -
EventType(optional):
string
Title:
Event Type
Maximum Length:30
The type of communication event. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the communication event was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the communication event. -
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. -
ResourceId(optional):
integer(int64)
Title:
Resource ID
The unique identifier of the communication resource. -
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 : 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.
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 : publicSectorCommunicationEvents-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The unique identifier of the agency associated with the communication event. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the communication event. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the communication event 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. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates whether the communication event is available to be used. The default value is N. -
EventCode(optional):
string
Title:
Event Code
Maximum Length:32
The communication event code. -
EventDescription(optional):
string
Title:
Description
Maximum Length:1000
The description of the communication event. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier of the communication event. Automatically generated by the application. -
EventName(optional):
string
Title:
Event Name
Maximum Length:500
The name of the communication event. -
EventType(optional):
string
Title:
Event Type
Maximum Length:30
The type of communication event. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the communication event was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the communication event. -
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. -
ResourceId(optional):
integer(int64)
Title:
Resource ID
The unique identifier of the communication resource. -
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 : 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.