Jump to

• Request
• Response

Update a communication event

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationEvents/{EventId}

Request

Path Parameters

• EventId(required): integer(int64)
  The unique identifier of the communication event. Automatically generated by the application.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "EmEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the event is enabled for the event management framework. The default value is N.",
            "nullable":false,
            "default":"N"
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication event.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "EventType":{
            "title":"Event Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of communication event.",
            "nullable":false
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":"500",
            "type":"string",
            "description":"The name of the communication event.",
            "nullable":false
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":"32",
            "type":"string",
            "description":"The communication event code.",
            "nullable":false
        },
        "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.",
            "nullable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the communication resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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.",
            "nullable":true
        },
        "EventRunType":{
            "maxLength":"18",
            "type":"string",
            "description":"Indicates how an event is configured to run, such as synchronously, asynchronously, and so on.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the communication event is available to be used. The default value is N.",
            "nullable":false
        },
        "EventDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the communication event.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorCommunicationEvents-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the communication event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the communication event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the communication event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the event is enabled for the event management framework. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication event.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "EventType":{
            "title":"Event Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of communication event.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":"500",
            "type":"string",
            "description":"The name of the communication event.",
            "nullable":false,
            "x-queryable":true
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":"32",
            "type":"string",
            "description":"The communication event code.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "EventResourceName":{
            "title":"Resource Name",
            "maxLength":"100",
            "type":"string",
            "description":"Specifies a resource code which can be used to identify an event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the communication resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier of the communication event. Automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EventRunType":{
            "maxLength":"18",
            "type":"string",
            "description":"Indicates how an event is configured to run, such as synchronously, asynchronously, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the communication event is available to be used. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "EventDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the communication event.",
            "nullable":true,
            "x-queryable":true
        },
        "OfferingId":{
            "maxLength":"80",
            "type":"string",
            "description":"The offering under which this resource falls.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the communication event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top