Create a notification recipient
post
/fscmRestApi/resources/11.13.18.05/collaborationSyncProfiles/{SyncProfileId}/child/notifications
Request
Path Parameters
-
SyncProfileId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
NotificationId: integer
(int64)
Value that uniquely identifies the sync profile notification recipient.
-
UserName: string
Maximum Length:
100
Login of the sync profile notification recipient. This attribute is required.
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 : collaborationSyncProfiles-notifications-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the sync profile notification. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the sync profile notification. -
DisplayName: string
Read Only:
true
Maximum Length:240
Name of the user displayed on the UI. -
Email: string
Read Only:
true
Maximum Length:240
Primary work email of the user. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the sync profile notification. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the sync profile notification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListName: string
Read Only:
true
Maximum Length:240
Listed name of the user. -
NotificationId: integer
(int64)
Value that uniquely identifies the sync profile notification recipient.
-
PersonId: integer
Read Only:
true
Value that uniquely identifies the person associated with the sync profile notification recipient. -
UserName: string
Maximum Length:
100
Login of the sync profile notification recipient. This attribute is required.
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
This example describes how to create a recipient to be notified when new demand is received.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/collaborationSyncProfiles/SyncProfileId/child/notifications"
For example:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/collaborationSyncProfiles/300100553780562/child/notifications"
Example Request Body
The following example includes the contents of the request
body in JSON format. In this example, a file attahment is uploaded to the purchase
order header successfully. You replace the request
payload in the cURL command with the contents of the Example Request Body.
The request payload specifies attribute values that the command will use in the
record that it creates.
[ { "UserName":"COLLABPLANNER02" } ]
Example Response Body
This example includes the contents of the response body in JSON format:
[ { "NotificationId": 300100553789582, "PersonId": 300100073976611, "UserName": "cindy.breeze", "DisplayName": null, "ListName": null, "Email": null, "CreatedBy": "COLLABPLANNER", "CreationDate": "2022-05-03T16:32:06+00:00", "LastUpdatedBy": "COLLABPLANNER", "LastUpdateDate": "2022-05-03T16:32:06.106+00:00", "@context": { "key": "300100553789582", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" }, "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/collaborationSyncProfiles/300100553780562/child/notifications/300100553789582", "name": "notifications", "kind": "item" }, { "rel": "canonical", "href": "https://server/fscmRestApi/resources/version/collaborationSyncProfiles/300100553780562/child/notifications/300100553789582", "name": "notifications", "kind": "item" }, { "rel": "parent", "href": "https://server/fscmRestApi/resources/version/collaborationSyncProfiles/300100553780562", "name": "collaborationSyncProfiles", "kind": "item" } ] } } ]