Jump to

• Request
• Response

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.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorCommunicationEvents-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication event.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the communication event.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the communication event was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"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":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the communication event is available to be used. The default value is N.",
            "title":"Enabled"
        },
        "EventCode":{
            "maxLength":32,
            "type":"string",
            "description":"The communication event code.",
            "title":"Event Code"
        },
        "EventDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the communication event.",
            "title":"Description"
        },
        "EventId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the communication event. Automatically generated by the application.",
            "title":"Event ID"
        },
        "EventName":{
            "maxLength":500,
            "type":"string",
            "description":"The name of the communication event.",
            "title":"Event Name"
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of communication event.",
            "title":"Event Type"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the communication event was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication event.",
            "title":"Last Updated By"
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"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":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the communication resource.",
            "title":"Resource ID"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCommunicationEvents-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication event.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the communication event.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the communication event was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"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":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the communication event is available to be used. The default value is N.",
            "title":"Enabled"
        },
        "EventCode":{
            "maxLength":32,
            "type":"string",
            "description":"The communication event code.",
            "title":"Event Code"
        },
        "EventDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the communication event.",
            "title":"Description"
        },
        "EventId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the communication event. Automatically generated by the application.",
            "title":"Event ID"
        },
        "EventName":{
            "maxLength":500,
            "type":"string",
            "description":"The name of the communication event.",
            "title":"Event Name"
        },
        "EventType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of communication event.",
            "title":"Event Type"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the communication event was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication event.",
            "title":"Last Updated By"
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"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":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the communication resource.",
            "title":"Resource ID"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top