ポップアップ・アイテムの取得
get
/fscmRestApi/resources/11.13.18.05/atkPopupItems/{MessageId}
リクエスト
パス・パラメータ
- MessageId(required): integer(int64)
メッセージの一意の識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されている場合、フィールドはリソース・コレクション・ペイロードを生成する前に親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1> = <val1>, <attr2> = <value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 セパレータとしてカンマを使用して複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、書式" Child.NestedChild " (例)に従って指定することもできます: ?expand= Employees.Managers ). ネストされた子が指定されている場合(例): Employees.Managers)、欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees, Employees.Managers" (従業員とマネージャを展開する)と同じです。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)、欠落している子は暗黙的に処理されます。 たとえば、"?fields= Employees.Managers:Empname"は、"?fields=;Employees:; Employees.Managers:Empname" (マネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers ) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース・アイテム・ペイロードがフィルタ処理されます。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプは実行時に変わる可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーがAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json
デフォルト・レスポンス
次の表に、このタスクのデフォルト・レスポンスを示します。
Headers
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプは実行時に変わる可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーがAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : atkPopupItems-item-response
タイプ:
Show Source
object
-
AdditionalAttributes: string
最大長:
2000
ポップアップ・アイテムについて取得された追加情報。 -
DisplayMenu: string
表示メニューの名前。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられているリンクの関係。 -
MessageCreationDate: 整数(int64)
タイトル:
Creation Date
通知が作成された日時。 -
MessageCreationTranslatedDate: string
読取り専用:
true
最大長:255
メッセージの翻訳バージョンが作成された日付。 -
MessageExpiryDate: 整数(int64)
お知らせ通知が期限切れに設定されている日付。
-
MessageId: 整数(int64)
メッセージの一意の識別子。
-
MessageSummary: string
タイトル:
Message Summary
最大長:2000
タスク詳細を含む通知のタイトル。 -
MsgCreationDbDate: string (date-time)
メッセージの作成日。
- NavigationURLKey: string
-
NotificationType: string
最大長:
30
通知のタイプです。 -
ObjectVersionNumber: integer (int32)
メッセージのバージョン。
-
PageParamListString: string
最大長:
400
ページに関連付けられたパラメータ。 -
SOAOutcomes: string
最大長:
256
SOAの結果。 -
SOAOutcomesArray: object SOAOutcomesArray
読取り専用:
true
SOA結果の配列。 -
SOAOutcomesDisplay: string
最大長:
256
表示されたSOA結果の配列。 -
SOAServer: string
最大長:
128
SOAサーバーの名前。 -
ソース: string
最大長:
30
デフォルト値:SOA_HUMAN_TASK
メッセージのソース。 -
ステータス: string
タイトル:
Status
最大長:20
デフォルト値:NEW
通知のステータス。 -
TaskCreator: string
最大長:
64
タスクの作成者を識別します。 -
TaskDetailsAvailableFlag: boolean
最大長:
1
デフォルト値:true
タスク詳細を使用できるかどうかを識別します。 -
TaskDisplayURL: string
最大長:
2000
タスク詳細ダイアログ・ボックスの表示に使用されるURL。 -
TaskflowId: string
最大長:
400
タスク・フローの一意の識別子。 -
TaskId: string
最大長:
64
一意のタスクの一意の識別子。 -
TaskState: string
最大長:
20
ワークフロー内のタスクの現在の状態。 -
TaskTabLabel: string
最大長:
400
タスクのラベル。 -
TfKeyListString: string
最大長:
400
タスク・フロー・パラメータ。 -
TfParameterString: string
最大長:
400
タスク・フローのパラメータ文字列。 -
ThingsToFinishState: string
最大長:
20
完了する状態を示します。 -
UmsMessageId: string
最大長:
64
メッセージの一意の識別子。 -
UserGUID: string
最大長:
64
割り当てられたユーザーの一意の識別子。 -
ViewId: string
最大長:
400
メッセージの表示識別子。
ネストされたスキーマ : SOAOutcomesArray
タイプ:
object
読取り専用:
true
SOA結果の配列。
ネストされたスキーマ : リンク
タイプ:
Show Source
object
-
href: string
タイトル:
hyperlink reference
関連付けられたリソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連付けられたリソースの種類。 -
name: string
タイトル:
name
関連付けられたリソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
リンク
- processOutcome
-
パラメータ:
- MessageId:
$request.path.MessageId
このメソッドは、ポップアップ・アイテムを承認または却下するために使用します。 - MessageId: