Jump to

• Request
• Response

Update an event

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkEvents/{EventId}

Request

Path Parameters

• EventId(required): integer(int64)
  The unique identifier of the event. The ID is 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)
  Default Value: 1

  The unique identifier of the agency associated with the resource action.
• DeletedFlag: string
  Maximum Length: 1

  Indicates whether the record is logically deleted. Valid values are Y for deleted record and N for active record. The default value is N.
• EmEnabled: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the event is enabled for the business rules framework. The default value is N.
• EnabledFlag: string
  Maximum Length: 1

  Indicates whether the event is available to be used in communication service. The default value is N.
• EventCode: string
  Title: Event Code

  Maximum Length: 32

  The event code.
• EventDescription: string
  Title: Event Description

  Maximum Length: 1000

  The description of the event.
• EventName: string
  Title: Event Name

  Maximum Length: 500

  The name of the event.
• EventRunType: string
  Maximum Length: 18

  Indicates how an event is configured to run, such as synchronously, asynchronously, and so on.
• EventType: string
  Maximum Length: 30

  The type of event.
• ModuleId: string
  Maximum Length: 32

  The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.
• OfferingId: string
  Maximum Length: 80

  The offering under which this event is categorized.
• ResourceEmEnabled: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the parent resource is enabled for use in the business rules framework. The default value is N.
• ResourceId: integer (int64)
  The unique identifier of the parent resource for this resource action.
• ResourceName: string
  Title: Business Object

  Maximum Length: 100

  The name of the parent resource.
• SeedDataLock: integer (int32)
  Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.

{
    "type":"object",
    "properties":{
        "EmEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the event is enabled for the business rules framework. The default value is N.",
            "nullable":false,
            "default":"N"
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the resource action.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "EventType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of event.",
            "nullable":false
        },
        "ResourceName":{
            "title":"Business Object",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the parent resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":"500",
            "type":"string",
            "description":"The name of the event.",
            "nullable":false
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":"32",
            "type":"string",
            "description":"The event code.",
            "nullable":false
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.",
            "nullable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the parent resource for this resource action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceEmEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the parent resource is enabled for use in the business rules framework. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is logically deleted. Valid values are Y for deleted record and N for active record. 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":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the event is available to be used in communication service. The default value is N.",
            "nullable":false
        },
        "EventDescription":{
            "title":"Event Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the event.",
            "nullable":true
        },
        "OfferingId":{
            "maxLength":"80",
            "type":"string",
            "description":"The offering under which this event is categorized.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : publicSectorBusinessRulesFrameworkEvents-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the agency associated with the resource action.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the event was created.
• DeletedFlag: string
  Maximum Length: 1

  Indicates whether the record is logically deleted. Valid values are Y for deleted record and N for active record. The default value is N.
• EmEnabled: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the event is enabled for the business rules framework. The default value is N.
• EnabledFlag: string
  Maximum Length: 1

  Indicates whether the event is available to be used in communication service. The default value is N.
• EventCode: string
  Title: Event Code

  Maximum Length: 32

  The event code.
• EventDescription: string
  Title: Event Description

  Maximum Length: 1000

  The description of the event.
• EventId: integer (int64)
  The unique identifier of the event. The ID is automatically generated by the application.
• EventName: string
  Title: Event Name

  Maximum Length: 500

  The name of the event.
• EventRunType: string
  Maximum Length: 18

  Indicates how an event is configured to run, such as synchronously, asynchronously, and so on.
• EventType: string
  Maximum Length: 30

  The type of event.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The user who last updated the event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.
• OfferingId: string
  Maximum Length: 80

  The offering under which this event is categorized.
• ResourceCode: string
  Read Only: true

  Maximum Length: 32

  The unique identifier for the resource for the event.
• ResourceDeletedFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the resource can be or has been deleted.
• ResourceDescription: string
  Title: Resource Description

  Read Only: true

  Maximum Length: 256

  The description of the resource for the event.
• ResourceEmEnabled: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the parent resource is enabled for use in the business rules framework. The default value is N.
• ResourceId: integer (int64)
  The unique identifier of the parent resource for this resource action.
• ResourceName: string
  Title: Business Object

  Maximum Length: 100

  The name of the parent resource.
• ResourcePath: string
  Read Only: true

  Maximum Length: 1000

  The path for accessing the resource for the event.
• SeedDataLock: integer (int32)
  Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.

{
    "type":"object",
    "properties":{
        "ResourceCode":{
            "maxLength":"32",
            "type":"string",
            "description":"The unique identifier for the resource for the event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the event is enabled for the business rules framework. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the resource action.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "EventType":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of event.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Business Object",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the parent resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":"500",
            "type":"string",
            "description":"The name of the event.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceDeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the resource can be or has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":"32",
            "type":"string",
            "description":"The event code.",
            "nullable":false,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourcePath":{
            "maxLength":"1000",
            "type":"string",
            "description":"The path for accessing the resource for the event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceDescription":{
            "title":"Resource Description",
            "maxLength":"256",
            "type":"string",
            "description":"The description of the resource for the event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the parent resource for this resource action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceEmEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the parent resource is enabled for use in the business rules framework. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is logically deleted. Valid values are Y for deleted record and N for active record. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"The unique identifier of the event. The ID is 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":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the event is available to be used in communication service. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "EventDescription":{
            "title":"Event Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the event.",
            "nullable":true,
            "x-queryable":true
        },
        "OfferingId":{
            "maxLength":"80",
            "type":"string",
            "description":"The offering under which this event is categorized.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the event.",
            "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