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:
Show Source
object
-
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
-
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.
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:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : SOAOutcomesArray
Type:
object
Read Only:
true
The array of SOA outcome.
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.
Links
- processOutcome
-
Parameters:
- MessageId:
$request.path.MessageId
This method is used to approve or reject a popup item. - MessageId: