1つの調達エージェントの取得
get
/fscmRestApi/resources/11.13.18.05/procurementAgents/{AssignmentId}
リクエスト
パス・パラメータ
- AssignmentId(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
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : procurementAgents-item-response
タイプ:
ソースを表示
object
-
AccessLevelToOtherAgentsAgreements: string
購買契約を管理するために他の調達エージェントが所有する文書へのアクセス・レベル。 有効な値は、なし、表示および完全です。 デフォルト値は「なし」です。
-
AccessLevelToOtherAgentsChecklists: string
コンプライアンス・チェックリストを管理するために他の調達エージェントが所有する文書へのアクセス・レベル。 指定可能な値は、なし、表示および完全です。 デフォルト値は「なし」です。
-
AccessLevelToOtherAgentsNegotiations: string
ネゴシエーションを管理するために他の調達エージェントが所有する文書へのアクセス・レベル。 有効な値は、なし、表示および完全です。 デフォルト値は「なし」です。
-
AccessLevelToOtherAgentsOrders: string
購買オーダーを管理するために他の調達エージェントが所有する文書へのアクセス・レベル。 有効な値は、なし、表示および完全です。 デフォルト値は「なし」です。
-
AccessLevelToOtherAgentsQualifications: string
サプライヤ資格を管理するために他の調達エージェントが所有する文書へのアクセス・レベル。 有効な値は、なし、表示および完全です。 デフォルト値は「なし」です。
-
AccessLevelToOtherAgentsRequisitions: string
購買依頼を管理するために他の調達エージェントが所有する文書へのアクセス・レベル。 指定可能な値は、なし、表示および完全です。 デフォルト値は「なし」です。
-
AccessLevelToOtherAgentsSourcingPrograms: string
ソーシング・プログラムを管理するために他の調達エージェントが所有する文書へのアクセス・レベル。 有効な値は、なし、表示および完全です。 デフォルト値は「なし」です。
-
Agent: string
タイトル:
Name
最大長:240
エージェントの名前。 エージェントの名前は、次の形式で指定する必要があります: 姓、名。 -
AgentEmail: string
タイトル:
Email
最大長:240
エージェントの電子メール・アドレス。 -
AgentId: integer (int64)
エージェントを一意に識別する値。
-
AnalyzeSpendAllowedFlag: boolean
タイトル:
Allowed
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、調達エージェントは支出を分析できます。 falseの場合、アプリケーションはこのアクセスを許可しません。 デフォルト値はfalseです。 -
AssignmentId: integer (int64)
調達エージェント割当を一意に識別する値。
-
DefaultPrinter: string
最大長:
80
調達エージェントのデフォルト・プリンタ。 -
DefaultRequisitioningBU: string
タイトル:
Name
最大長:240
デフォルト購買依頼発行ビジネス・ユニットの名前。 -
DefaultRequisitioningBUId: integer (int64)
デフォルトの購買依頼発行ビジネス・ユニットを一意に識別する値。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ManageAgreementsAllowedFlag: boolean
タイトル:
Allowed
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、調達エージェントは購買契約を管理できます。 falseの場合、アプリケーションはこのアクセスを許可しません。 デフォルト値はfalseです。 -
ManageAslAllowedFlag: boolean
タイトル:
Allowed
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、調達エージェントは承認済サプライヤ・リストのエントリを管理できます。 falseの場合、アプリケーションはこのアクセスを許可しません。 デフォルト値はfalseです。 -
ManageCatalogContentAllowedFlag: boolean
タイトル:
Allowed
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、調達エージェントはカタログ・コンテンツを管理できます。 falseの場合、アプリケーションはこのアクセスを許可しません。 デフォルト値はfalseです。 -
ManageChecklistsAllowedFlag: boolean
タイトル:
Allowed
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、調達エージェントはコンプライアンス・チェックリストを管理できます。 falseの場合、アプリケーションはこのアクセスを許可しません。 デフォルト値はfalseです。 -
ManageNegotiationsAllowedFlag: boolean
タイトル:
Allowed
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、調達エージェントはネゴシエーションを管理できます。 falseの場合、アプリケーションはこのアクセスを許可しません。 デフォルト値はfalseです。 -
ManageOrdersAllowedFlag: boolean
タイトル:
Allowed
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、調達エージェントは購買オーダーを管理できます。 falseの場合、アプリケーションはこのアクセスを許可しません。 デフォルト値はfalseです。 -
ManageQualificationsAllowedFlag: boolean
タイトル:
Allowed
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、調達エージェントはサプライヤ資格を管理できます。 falseの場合、アプリケーションはこのアクセスを許可しません。 デフォルト値はfalseです。 -
ManageRequisitionsAllowedFlag: boolean
タイトル:
Allowed
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、調達エージェントは購買依頼を管理できます。 falseの場合、アプリケーションはこのアクセスを許可しません。 デフォルト値はfalseです。 -
ManageSourcingProgramsAllowedFlag: boolean
タイトル:
Allowed
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、調達エージェントはソーシング・プログラムを管理できます。 falseの場合、アプリケーションはこのアクセスを許可しません。 デフォルト値はfalseです。 -
ManageSuppliersAllowedFlag: boolean
タイトル:
Allowed
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、調達エージェントはサプライヤを管理できます。 falseの場合、アプリケーションはこのアクセスを許可しません。 デフォルト値はfalseです。 -
ProcurementBU: string
タイトル:
Name
最大長:240
エージェントが割り当てられている調達ビジネス・ユニットの名前。 -
ProcurementBUId: integer (int64)
調達ビジネス・ユニットを一意に識別する値。
-
Status: string
タイトル:
Meaning
最大長:80
調達エージェントのステータスです。 有効な値は非アクティブおよびアクティブです。 デフォルト値はアクティブです。 -
StatusCode: string
タイトル:
Status
最大長:1
デフォルト値:Y
調達エージェントのステータスを識別する略称です。 次の値のいずれかです。 Y: 調達エージェントのステータスはアクティブです。 N: 調達エージェントのステータスが非アクティブです。 デフォルト値は「Y」です。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
例
この例では、1つの調達エージェントを取得する方法を説明します。
cURLコマンドの例
例1 コマンド
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/procurementAgents/?q=AgentEmail"
たとえば、次のコマンドは、エージェントEメールがjohn.brown@example.comである調達エージェントを取得します:
curl -u username:password "https://servername/fscmRestApi/resources/version/procurementAgents/?q=AgentEmail='john.brown@example.com'"
例1 レスポンス本文
JSON形式のレスポンス本文の例を次に示します。
{ "AssignmentId": 20000000000587, "Agent": "Brown, John", "AgentId": 8156, "AgentEmail": "john.brown@example.com", "ProcurementBU": "Vision Services", "ProcurementBUId": 458, "Status" : "Active", "StatusCode" : "Y", "DefaultRequisitioningBU" : null, "DefaultRequisitioningBUId" : null, "DefaultPrinter" : null, "ManageRequisitionsAllowedFlag" : false, "AccessLevelToOtherAgentsRequisitions" : "None", "ManageOrdersAllowedFlag" : false, "AccessLevelToOtherAgentsOrders" : "None", "ManageAgreementsAllowedFlag" : false, "AccessLevelToOtherAgentsAgreements" : "None", "ManageNegotiationsAllowedFlag" : false, "AccessLevelToOtherAgentsNegotiations" : "None", "ManageSourcingProgramsAllowedFlag" : false, "AccessLevelToOtherAgentsSourcingPrograms" : "None", "ManageCatalogContentAllowedFlag" : false, "ManageSuppliersAllowedFlag" : false, "ManageQualificationsAllowedFlag" : false, "AccessLevelToOtherAgentsQualifications" : "None", "ManageAslAllowedFlag" : false, "AnalyzeSpendAllowedFlag" : false, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000587", "name" : "procurementAgents", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000B77040000000B737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E00020000000278" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000587", "name" : "procurementAgents", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000587/lov/StatusAccessor", "name" : "StatusAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000587/lov/ActivePersonAccessor", "name" : "ActivePersonAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000587/lov/PrinterAccessor", "name" : "PrinterAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000587/lov/AccessOthersLevelNoModifyActionAccessor", "name" : "AccessOthersLevelNoModifyActionAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000587/lov/AccessOthersLevelAccessor", "name" : "AccessOthersLevelAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000587/lov/ProcurementBUAccessor", "name" : "ProcurementBUAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000587/lov/DefaultReqBuAccessor", "name" : "DefaultReqBuAccessor", "kind" : "collection" }] }
例2 コマンド
たとえば、次のコマンドは、割当識別子が300100124649103の調達エージェントを取得します:
curl -u username:password "https://servername/fscmRestApi/resources/version/procurementAgents/?q=AssignmentId=300100124649103
例2 レスポンス本文
JSON形式のレスポンス本文の例を次に示します。
{ "AssignmentId": 300100124649103, "Agent": "Johnson, John", "AgentId": 8157, "AgentEmail": "john.johnson@example.com", "ProcurementBU": "Vision Operations BU", "ProcurementBUId": 300100009422512, "Status": "Active", "StatusCode": "Y", "DefaultRequisitioningBU": null, "DefaultRequisitioningBUId": null, "DefaultPrinter": null, "ManageRequisitionsAllowedFlag": true, "AccessLevelToOtherAgentsRequisitions": "View", "ManageOrdersAllowedFlag": true, "AccessLevelToOtherAgentsOrders": "Full", "ManageAgreementsAllowedFlag": true, "AccessLevelToOtherAgentsAgreements": "None", "ManageNegotiationsAllowedFlag": true, "AccessLevelToOtherAgentsNegotiations": "None", "ManageSourcingProgramsAllowedFlag": true, "AccessLevelToOtherAgentsSourcingPrograms": "None", "ManageCatalogContentAllowedFlag": true, "ManageSuppliersAllowedFlag": true, "ManageQualificationsAllowedFlag": true, "AccessLevelToOtherAgentsQualifications": "None", "ManageAslAllowedFlag": true, "AnalyzeSpendAllowedFlag": true, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103", "name" : "procurementAgents", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000B77040000000B737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E00020000000278" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103", "name" : "procurementAgents", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/StatusAccessor", "name" : "StatusAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/ActivePersonAccessor", "name" : "ActivePersonAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/PrinterAccessor", "name" : "PrinterAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/AccessOthersLevelNoModifyActionAccessor", "name" : "AccessOthersLevelNoModifyActionAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/AccessOthersLevelAccessor", "name" : "AccessOthersLevelAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/ersion/procurementAgents/300100124649103/lov/ProcurementBUAccessor", "name" : "ProcurementBUAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/DefaultReqBuAccessor", "name" : "DefaultReqBuAccessor", "kind" : "collection" }] }