REST API for Common Features in Oracle Fusion Cloud Applications

Create a popup items

post

/fscmRestApi/resources/11.13.18.05/atkPopupItems

Request

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.
Upsert-Mode:

Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

AdditionalAttributes: string

Maximum Length: 2000

Additional information captured about the popup item.
DisplayMenu: string

The name of the display menu.
MessageCreationDate: integer (int64)

Title: Creation Date

The date and time when the notification was created.
MessageExpiryDate: integer (int64)

The date on which the announcement notification is set to expire.
MessageId: integer (int64)

The unique identifier of the message.
MessageSummary: string

Title: Message Summary

Maximum Length: 2000

The title of the notification containing the task details.
MsgCreationDbDate: string (date-time)

The date on which the message was created.
NavigationURLKey: string

Maximum Length: 80

The URL used for navigation.
NotificationType: string

Maximum Length: 30

The type of notification.
ObjectVersionNumber: integer (int32)

The version of the message.
PageParamListString: string

Maximum Length: 400

The parameters associated with the page.
SOAOutcomes: string

Maximum Length: 256

The SOA outcome.
SOAOutcomesDisplay: string

Maximum Length: 256

The displayed array of SOA outcome.
SOAServer: string

Maximum Length: 128

The name of the SOA server.
Source: string

Maximum Length: 30

Default Value: SOA_HUMAN_TASK

The source of the message.
Status: string

Title: Status

Maximum Length: 20

Default Value: NEW

The status of the notification.
TaskCreator: string

Maximum Length: 64

Identifies who created the task.
TaskDetailsAvailableFlag: boolean

Maximum Length: 1

Default Value: true

Identifies if the task details are available.
TaskDisplayURL: string

Maximum Length: 2000

The URL used for displaying the task details dialog box.
TaskflowId: string

Maximum Length: 400

The unique identifier of the task flow.
TaskId: string

Maximum Length: 64

The unique identifier of the task.
TaskState: string

Maximum Length: 20

The current state of the task in the workflow.
TaskTabLabel: string

Maximum Length: 400

The label of the task.
TfKeyListString: string

Maximum Length: 400

The task flow parameters.
TfParameterString: string

Maximum Length: 400

The task flow parameter strings.
ThingsToFinishState: string

Maximum Length: 20

Indicates the state of things to complete.
UmsMessageId: string

Maximum Length: 64

The unique identifier for the message.
UserGUID: string

Maximum Length: 64

The unique identifier of the assigned user.
ViewId: string

Maximum Length: 400

The view identifier for the message.

{ "type":"object", "properties":{ "SOAServer":{ "maxLength":128, "type":"string", "description":"The name of the SOA server.", "nullable":true }, "TaskId":{ "maxLength":64, "type":"string", "description":"The unique identifier of the task.", "nullable":true }, "UserGUID":{ "maxLength":64, "type":"string", "description":"The unique identifier of the assigned user.", "nullable":false }, "TaskCreator":{ "maxLength":64, "type":"string", "description":"Identifies who created the task.", "nullable":true }, "MsgCreationDbDate":{ "type":"string", "description":"The date on which the message was created.", "format":"date-time", "nullable":true, "x-hints":{ "dependencies":[ "MessageCreationDate" ] } }, "TaskDisplayURL":{ "maxLength":2000, "type":"string", "description":"The URL used for displaying the task details dialog box.", "nullable":true }, "Source":{ "maxLength":30, "type":"string", "description":"The source of the message.", "nullable":true, "default":"SOA_HUMAN_TASK" }, "NavigationURLKey":{ "maxLength":80, "type":"string", "description":"The URL used for navigation.", "nullable":true }, "TaskflowId":{ "maxLength":400, "type":"string", "description":"The unique identifier of the task flow.", "nullable":true }, "ThingsToFinishState":{ "maxLength":20, "type":"string", "description":"Indicates the state of things to complete.", "nullable":true }, "ObjectVersionNumber":{ "type":"integer", "description":"The version of the message.", "format":"int32", "nullable":true, "x-hints":{ "precision":9 } }, "AdditionalAttributes":{ "maxLength":2000, "type":"string", "description":"Additional information captured about the popup item.", "nullable":true }, "SOAOutcomes":{ "maxLength":256, "type":"string", "description":"The SOA outcome.", "nullable":true }, "MessageExpiryDate":{ "type":"integer", "description":"The date on which the announcement notification is set to expire.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 } }, "MessageSummary":{ "title":"Message Summary", "maxLength":2000, "type":"string", "description":"The title of the notification containing the task details.", "nullable":true }, "TfKeyListString":{ "maxLength":400, "type":"string", "description":"The task flow parameters.", "nullable":true }, "Status":{ "title":"Status", "maxLength":20, "type":"string", "description":"The status of the notification.", "nullable":true, "default":"NEW" }, "TaskTabLabel":{ "maxLength":400, "type":"string", "description":"The label of the task.", "nullable":true }, "SOAOutcomesDisplay":{ "maxLength":256, "type":"string", "description":"The displayed array of SOA outcome.", "nullable":true }, "PageParamListString":{ "maxLength":400, "type":"string", "description":"The parameters associated with the page.", "nullable":true }, "UmsMessageId":{ "maxLength":64, "type":"string", "description":"The unique identifier for the message.", "nullable":true }, "MessageCreationDate":{ "title":"Creation Date", "type":"integer", "description":"The date and time when the notification was created.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 } }, "DisplayMenu":{ "type":"string", "description":"The name of the display menu.", "nullable":true }, "NotificationType":{ "maxLength":30, "type":"string", "description":"The type of notification.", "nullable":true }, "TaskDetailsAvailableFlag":{ "maxLength":1, "type":"boolean", "description":"Identifies if the task details are available.", "nullable":false, "default":true }, "ViewId":{ "maxLength":400, "type":"string", "description":"The view identifier for the message.", "nullable":true }, "TfParameterString":{ "maxLength":400, "type":"string", "description":"The task flow parameter strings.", "nullable":true }, "TaskState":{ "maxLength":20, "type":"string", "description":"The current state of the task in the workflow.", "nullable":true }, "MessageId":{ "type":"integer", "description":"The unique identifier of the message.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"true" } } } }

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

Type: object

Show Source

AdditionalAttributes: string

Maximum Length: 2000

Additional information captured about the popup item.
DisplayMenu: string

The name of the display menu.
links: array Links

Title: Links

The link relations associated with the resource instance.
MessageCreationDate: integer (int64)

Title: Creation Date

The date and time when the notification was created.
MessageCreationTranslatedDate: string

Read Only: true

Maximum Length: 255

The date on which the translated version of the message was created.
MessageExpiryDate: integer (int64)

The date on which the announcement notification is set to expire.
MessageId: integer (int64)

The unique identifier of the message.
MessageSummary: string

Title: Message Summary

Maximum Length: 2000

The title of the notification containing the task details.
MsgCreationDbDate: string (date-time)

The date on which the message was created.
NavigationURLKey: string

Maximum Length: 80

The URL used for navigation.
NotificationType: string

Maximum Length: 30

The type of notification.
ObjectVersionNumber: integer (int32)

The version of the message.
PageParamListString: string

Maximum Length: 400

The parameters associated with the page.
SOAOutcomes: string

Maximum Length: 256

The SOA outcome.
SOAOutcomesArray: object SOAOutcomesArray

Read Only: true

The array of SOA outcome.
SOAOutcomesDisplay: string

Maximum Length: 256

The displayed array of SOA outcome.
SOAServer: string

Maximum Length: 128

The name of the SOA server.
Source: string

Maximum Length: 30

Default Value: SOA_HUMAN_TASK

The source of the message.
Status: string

Title: Status

Maximum Length: 20

Default Value: NEW

The status of the notification.
TaskCreator: string

Maximum Length: 64

Identifies who created the task.
TaskDetailsAvailableFlag: boolean

Maximum Length: 1

Default Value: true

Identifies if the task details are available.
TaskDisplayURL: string

Maximum Length: 2000

The URL used for displaying the task details dialog box.
TaskflowId: string

Maximum Length: 400

The unique identifier of the task flow.
TaskId: string

Maximum Length: 64

The unique identifier of the task.
TaskState: string

Maximum Length: 20

The current state of the task in the workflow.
TaskTabLabel: string

Maximum Length: 400

The label of the task.
TfKeyListString: string

Maximum Length: 400

The task flow parameters.
TfParameterString: string

Maximum Length: 400

The task flow parameter strings.
ThingsToFinishState: string

Maximum Length: 20

Indicates the state of things to complete.
UmsMessageId: string

Maximum Length: 64

The unique identifier for the message.
UserGUID: string

Maximum Length: 64

The unique identifier of the assigned user.
ViewId: string

Maximum Length: 400

The view identifier for the message.

{ "type":"object", "properties":{ "SOAServer":{ "maxLength":128, "type":"string", "description":"The name of the SOA server.", "nullable":true, "x-queryable":true }, "TaskId":{ "maxLength":64, "type":"string", "description":"The unique identifier of the task.", "nullable":true, "x-queryable":true }, "UserGUID":{ "maxLength":64, "type":"string", "description":"The unique identifier of the assigned user.", "nullable":false, "x-queryable":true }, "TaskCreator":{ "maxLength":64, "type":"string", "description":"Identifies who created the task.", "nullable":true, "x-queryable":true }, "MsgCreationDbDate":{ "type":"string", "description":"The date on which the message was created.", "format":"date-time", "nullable":true, "x-hints":{ "dependencies":[ "MessageCreationDate" ] }, "x-queryable":true }, "TaskDisplayURL":{ "maxLength":2000, "type":"string", "description":"The URL used for displaying the task details dialog box.", "nullable":true, "x-queryable":true }, "Source":{ "maxLength":30, "type":"string", "description":"The source of the message.", "nullable":true, "default":"SOA_HUMAN_TASK", "x-queryable":true }, "NavigationURLKey":{ "maxLength":80, "type":"string", "description":"The URL used for navigation.", "nullable":true, "x-queryable":true }, "TaskflowId":{ "maxLength":400, "type":"string", "description":"The unique identifier of the task flow.", "nullable":true, "x-queryable":true }, "ThingsToFinishState":{ "maxLength":20, "type":"string", "description":"Indicates the state of things to complete.", "nullable":true, "x-queryable":true }, "ObjectVersionNumber":{ "type":"integer", "description":"The version of the message.", "format":"int32", "nullable":true, "x-hints":{ "precision":9 }, "x-queryable":true }, "AdditionalAttributes":{ "maxLength":2000, "type":"string", "description":"Additional information captured about the popup item.", "nullable":true, "x-queryable":true }, "SOAOutcomes":{ "maxLength":256, "type":"string", "description":"The SOA outcome.", "nullable":true, "x-queryable":true }, "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } }, "MessageExpiryDate":{ "type":"integer", "description":"The date on which the announcement notification is set to expire.", "format":"int64", "nullable":true, "x-hints":{ "precision":18 }, "x-queryable":true }, "MessageSummary":{ "title":"Message Summary", "maxLength":2000, "type":"string", "description":"The title of the notification containing the task details.", "nullable":true, "x-queryable":true }, "TfKeyListString":{ "maxLength":400, "type":"string", "description":"The task flow parameters.", "nullable":true, "x-queryable":true }, "Status":{ "title":"Status", "maxLength":20, "type":"string", "description":"The status of the notification.", "nullable":true, "default":"NEW", "x-queryable":true }, "TaskTabLabel":{ "maxLength":400, "type":"string", "description":"The label of the task.", "nullable":true, "x-queryable":true }, "SOAOutcomesDisplay":{ "maxLength":256, "type":"string", "description":"The displayed array of SOA outcome.", "nullable":true, "x-queryable":true }, "MessageCreationTranslatedDate":{ "maxLength":255, "type":"string", "description":"The date on which the translated version of the message was created.", "nullable":true, "readOnly":true, "x-hints":{ "dependencies":[ "MessageCreationDate" ] }, "x-queryable":true }, "PageParamListString":{ "maxLength":400, "type":"string", "description":"The parameters associated with the page.", "nullable":true, "x-queryable":true }, "UmsMessageId":{ "maxLength":64, "type":"string", "description":"The unique identifier for the message.", "nullable":true, "x-queryable":true }, "SOAOutcomesArray":{ "type":"object", "description":"The array of SOA outcome.", "nullable":true, "readOnly":true, "x-hints":{ "dependencies":[ "SOAOutcomes", "SOAOutcomesDisplay" ] }, "x-queryable":true }, "MessageCreationDate":{ "title":"Creation Date", "type":"integer", "description":"The date and time when the notification was created.", "format":"int64", "nullable":false, "x-hints":{ "precision":18 }, "x-queryable":true }, "DisplayMenu":{ "type":"string", "description":"The name of the display menu.", "nullable":true, "x-queryable":true }, "NotificationType":{ "maxLength":30, "type":"string", "description":"The type of notification.", "nullable":true, "x-queryable":true }, "TaskDetailsAvailableFlag":{ "maxLength":1, "type":"boolean", "description":"Identifies if the task details are available.", "nullable":false, "default":true, "x-queryable":true }, "ViewId":{ "maxLength":400, "type":"string", "description":"The view identifier for the message.", "nullable":true, "x-queryable":true }, "TfParameterString":{ "maxLength":400, "type":"string", "description":"The task flow parameter strings.", "nullable":true, "x-queryable":true }, "TaskState":{ "maxLength":20, "type":"string", "description":"The current state of the task in the workflow.", "nullable":true, "x-queryable":true }, "MessageId":{ "type":"integer", "description":"The unique identifier of the message.", "format":"int64", "nullable":false, "x-hints":{ "precision":18, "fnd:GLOBALLY_UNIQUE":"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 : SOAOutcomesArray

Type: object

Read Only: true

The array of SOA outcome.

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." } } }

Links

processOutcome

Operation: /fscmRestApi/resources/11.13.18.05/atkPopupItems/{MessageId}/action/processOutcome

Parameters:

MessageId: $request.path.MessageId

This method is used to approve or reject a popup item.