Update the enabled indicator for a business event
patch
/fscmRestApi/resources/11.13.18.05/erpBusinessEvents/{ErpBusinessEventId}
Request
Path Parameters
-
ErpBusinessEventId(required): integer(int64)
Unique identifier of the business event.
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
Root Schema : schema
Type:
Show Source
object
-
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
The indicator which designates whether an individual business event can be initiated.
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 : erpBusinessEvents-item-response
Type:
Show Source
object
-
BusinessEventCode: string
Title:
Business Event Code
Read Only:true
Maximum Length:150
Business flow artifact code associated with a business event. -
BusinessEventIdentifier: string
Title:
Business Event Identifier
Read Only:true
Maximum Length:150
Unique identifier of the business event in the public business event catalog. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the business event record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the business event record was created. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
The indicator which designates whether an individual business event can be initiated. -
ErpBusinessEventId: integer
(int64)
Title:
Business Event ID
Read Only:true
Unique identifier of the business event. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when a business event record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the business event record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session ID of the user who last updated the business event record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Examples
The following example shows how to create a business event record by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpBusinessEvents/100100120766717
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "EnabledFlag": true }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "BusinessEventCode": "JournalBatchApproved", "BusinessEventIdentifier": "Journal_Batch_Approved", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2019-07-28T18:19:19.261+00:00", "EnabledFlag": true, "LastUpdateDate": "2020-08-21T09:54:00+00:00", "LastUpdateLogin": "AAF07631468304A4E0538C96F40A10A1", "LastUpdatedBy": "FINUSER1", "ErpBusinessEventId": 100100120766717, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpBusinessEvents/100100120766717", "name": "erpBusinessEvents", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/erpBusinessEvents/100100120766717", "name": "erpBusinessEvents", "kind": "item" } ] }