1つのコンテンツ・ゾーンの取得
get
/fscmRestApi/resources/11.13.18.05/contentZones/{contentZonesUniqID}
リクエスト
パス・パラメータ
- contentZonesUniqID(required): string
これは、コンテンツ・ゾーン・リソースのコンポジット・キーを構成し、コンテンツ・ゾーンのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、コンテンツ・ゾーンの特定のインスタンスに移動してハッシュ・キーを取得するために、コンテンツ・ゾーン・コレクション・リソースを問い合せる必要があります。
問合せパラメータ
- 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
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
ヘッダー・パラメータ
- Effective-Of:
このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた
= 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。のリストです。 - 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のデフォルト・バージョンを選択します。
ルート・スキーマ : contentZones-item-response
タイプ:
ソースを表示
object
-
catalogAssignments: array Catalog Assignments
タイトル:
Catalog Assignments
カタログ割当リソースは、コンテンツ・ゾーンのカタログ割当を管理します。 ローカル・カタログ・タイプとパンチ・アウト・カタログ・タイプ、情報カタログ・タイプをコンテンツ・ゾーンに割り当てることができます。 -
ContentZone: string
タイトル:
Content Zone
最大長:30
コンテンツ・ゾーンの名前。 -
ContentZoneId: integer (int64)
読取り専用:
true
コンテンツ・ゾーンを一意に識別する値。 -
CreatedBy: string
読取り専用:
true
最大長:64
コンテンツ・ゾーンを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーがコンテンツ・ゾーンを作成した日時。 -
Description: string
タイトル:
Description
最大長:240
コンテンツ・ゾーンの摘要。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
コンテンツ・ゾーンを最後に更新したユーザー。 -
LastUpdatedDate: string (date-time)
読取り専用:
true
ユーザーがコンテンツ・ゾーンを最後に更新した日時。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ProcurementBU: string
タイトル:
Procurement BU
コンテンツ・ゾーンが作成される調達ビジネス・ユニットの名前。 -
ProcurementBUId: integer (int64)
コンテンツ・ゾーンが作成される調達ビジネス・ユニットを一意に識別する値。
-
publicShoppingListAssignments: array Public Shopping List Assignments
タイトル:
Public Shopping List Assignments
公開ショッピング・リスト割当リソースは、コンテンツ・ゾーンの公開ショッピング・リスト割当を管理します。 -
SecuredBy: string
タイトル:
Secured By
コンテンツ・ゾーンの保護方法を決定するセキュリティ値。 有効な値は、「すべての購買依頼発行BU」、「購買依頼発行BU」、「就業者」または「すべての調達エージェント」です。 -
SecuredByCode: string
最大長:
18
コンテンツ・ゾーンがすべての購買依頼発行BU、特定の購買依頼発行BU、特定の就業者またはすべての調達エージェントによって保護されているかどうかを識別する略称です。 有効な値は、AVAIL_ALL_REQ_BUS、SECURED_BY_BU、SECURED_BY_WORKERまたはAVAIL_ALL_WORKERSです。 -
securityAssignments: array Security Assignments
タイトル:
Security Assignments
セキュリティ割当リソースは、BUまたは就業者を購買依頼発行することによって、コンテンツ・ゾーンのセキュリティ・アクセス割当を管理します。 -
smartFormAssignments: array Smart Form Assignments
タイトル:
Smart Form Assignments
スマート・フォーム割当リソースは、コンテンツ・ゾーンのスマート・フォーム割当を管理します。 スマート・フォームは、購買依頼発行の使用に対してのみコンテンツ・ゾーンに割り当てることができます。 -
Usage: string
タイトル:
Usage
コンテンツ・ゾーンが適用される場所を決定するために使用します。 有効な値は、「購買依頼発行」または「調達」です。 -
UsageCode: string
最大長:
15
コンテンツ・ゾーンが購買依頼発行または調達に使用されるかどうかを識別する略称です。 有効な値は、REQUISITIONINGまたはPROCUREMENTです。
ネストされたスキーマ : カタログ割当
タイプ:
array
タイトル:
Catalog Assignments
カタログ割当リソースは、コンテンツ・ゾーンのカタログ割当を管理します。 ローカル・カタログ・タイプとパンチ・アウト・カタログ・タイプ、情報カタログ・タイプをコンテンツ・ゾーンに割り当てることができます。
ソースを表示
ネストされたスキーマ : 公開ショッピング・リスト割当
タイプ:
array
タイトル:
Public Shopping List Assignments
公開ショッピング・リスト割当リソースは、コンテンツ・ゾーンの公開ショッピング・リスト割当を管理します。
ソースを表示
ネストされたスキーマ : セキュリティ割当
タイプ:
array
タイトル:
Security Assignments
セキュリティ割当リソースは、BUまたは就業者を購買依頼発行することによって、コンテンツ・ゾーンのセキュリティ・アクセス割当を管理します。
ソースを表示
ネストされたスキーマ : スマート・フォーム割当
タイプ:
array
タイトル:
Smart Form Assignments
スマート・フォーム割当リソースは、コンテンツ・ゾーンのスマート・フォーム割当を管理します。 スマート・フォームは、購買依頼発行の使用に対してのみコンテンツ・ゾーンに割り当てることができます。
ソースを表示
ネストされたスキーマ : contentZones-catalogAssignments-item-response
タイプ:
ソースを表示
object
-
Catalog: string
タイトル:
Catalog
コンテンツ・ゾーンに割り当てられているカタログの名前。 -
CatalogAssignmentId: integer (int64)
読取り専用:
true
カタログ割当を一意に識別する値。 -
CatalogId: integer (int64)
コンテンツ・ゾーンに割り当てられたカタログを一意に識別する値。
-
CatalogType: string
タイトル:
Catalog Type
読取り専用:true
最大長:80
コンテンツ・ゾーンに割り当てられているカタログのタイプです。 有効な値は、「ローカル」、「パンチ・アウト」または「情報」です。 -
CatalogTypeCode: string
読取り専用:
true
最大長:15
カタログのタイプを識別する略称。 有効な値は、LOCAL、PUNCHOUTまたはINFORMATIONALです。 -
ContentZoneId: integer (int64)
読取り専用:
true
コンテンツ・ゾーンを一意に識別する値。 -
CreatedBy: string
読取り専用:
true
最大長:64
カタログ割当を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーがカタログ割当を作成した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
カタログ割当を最後に更新したユーザー。 -
LastUpdatedDate: string (date-time)
読取り専用:
true
ユーザーがカタログ割当を最後に更新した日時。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : contentZones-publicShoppingListAssignments-item-response
タイプ:
ソースを表示
object
-
ContentZoneId: integer (int64)
読取り専用:
true
コンテンツ・ゾーンを一意に識別する値。 -
CreatedBy: string
読取り専用:
true
最大長:64
公開ショッピング・リスト割当を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーが公開ショッピング・リスト割当を作成した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
公開ショッピング・リスト割当を最近更新したユーザー。 -
LastUpdatedDate: string (date-time)
読取り専用:
true
ユーザーが公開ショッピング・リスト割当を最後に更新した日時。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PublicShoppingList: string
タイトル:
Public Shopping List
コンテンツ・ゾーンに割り当てられた公開ショッピング・リストの名前。 -
PublicShoppingListAssignmentId: integer (int64)
読取り専用:
true
公開ショッピング・リスト割当を一意に識別する値。 -
PublicShoppingListId: integer (int64)
コンテンツ・ゾーンに割り当てられた公開ショッピング・リストを一意に識別する値。
ネストされたスキーマ : contentZones-securityAssignments-item-response
タイプ:
ソースを表示
object
-
ContentZoneId: integer (int64)
読取り専用:
true
コンテンツ・ゾーンを一意に識別する値。 -
ContentZoneSecurityAssignmentId: integer (int64)
読取り専用:
true
セキュリティ割当を一意に識別する値。 -
CreatedBy: string
読取り専用:
true
最大長:64
セキュリティ割当を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーがセキュリティ割当を作成した日時。 -
LastUpdateDate: string (date-time)
読取り専用:
true
セキュリティ割当を最後に更新したユーザー。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
ユーザーがセキュリティ割当を最後に更新した日時。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
RequisitioningBU: string
タイトル:
Requisitioning BU
コンテンツ・ゾーンが割り当てられている購買依頼発行ビジネス・ユニットの名前。 -
RequisitioningBUId: integer (int64)
デフォルト値:
-2
コンテンツ・ゾーンが割り当てられている購買依頼発行ビジネス・ユニットを一意に識別する値。 -
Worker: string
タイトル:
Worker
読取り専用:true
最大長:240
コンテンツ・ゾーンが割り当てられている就業者の名前。 -
WorkerEmail: string
タイトル:
Worker Email
コンテンツ・ゾーンが割り当てられている就業者のEメール・アドレス。 -
WorkerId: integer (int64)
デフォルト値:
-2
コンテンツ・ゾーンが割り当てられている就業者を一意に識別する値。
ネストされたスキーマ : contentZones-smartFormAssignments-item-response
タイプ:
ソースを表示
object
-
ContentZoneId: integer (int64)
読取り専用:
true
コンテンツ・ゾーンを一意に識別する値。 -
CreatedBy: string
読取り専用:
true
最大長:64
スマート・フォーム割当を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーがスマート・フォーム割当を作成した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
スマート・フォーム割当を最後に更新したユーザー。 -
LastUpdatedDate: string (date-time)
読取り専用:
true
ユーザーがスマート・フォーム割当を最後に更新した日時。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
SmartForm: string
タイトル:
Smart Form
コンテンツ・ゾーンに割り当てられているスマート・フォームの名前。 -
SmartFormAssignmentId: integer (int64)
読取り専用:
true
スマート・フォーム割当を一意に識別する値。 -
SmartFormId: integer (int64)
コンテンツ・ゾーンに割り当てられたスマート・フォームを一意に識別する値。
リンク
- catalogAssignments
-
パラメータ:
- contentZonesUniqID:
$request.path.contentZonesUniqID
カタログ割当リソースは、コンテンツ・ゾーンのカタログ割当を管理します。 ローカル・カタログ・タイプとパンチ・アウト・カタログ・タイプ、情報カタログ・タイプをコンテンツ・ゾーンに割り当てることができます。 - contentZonesUniqID:
- publicShoppingListAssignments
-
パラメータ:
- contentZonesUniqID:
$request.path.contentZonesUniqID
公開ショッピング・リスト割当リソースは、コンテンツ・ゾーンの公開ショッピング・リスト割当を管理します。 - contentZonesUniqID:
- securityAssignments
-
パラメータ:
- contentZonesUniqID:
$request.path.contentZonesUniqID
セキュリティ割当リソースは、BUまたは就業者を購買依頼発行することによって、コンテンツ・ゾーンのセキュリティ・アクセス割当を管理します。 - contentZonesUniqID:
- smartFormAssignments
-
パラメータ:
- contentZonesUniqID:
$request.path.contentZonesUniqID
スマート・フォーム割当リソースは、コンテンツ・ゾーンのスマート・フォーム割当を管理します。 スマート・フォームは、購買依頼発行の使用に対してのみコンテンツ・ゾーンに割り当てることができます。 - contentZonesUniqID:
例
この例では、1つのコンテンツ・ゾーンを取得する方法について説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/contentZones/contentZonesUniqID"
たとえば:
curl -u username:password "https://servername/fscmRestApi/resources/version/contentZones/300100585274636"
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{ "ContentZoneId": 300100585274636, "ContentZone": "Office Supplies", "ProcurementBUId": 1017, "ProcurementBU": "Vision Italy", "Description": "This content zone is for requisitioning and secured by workers", "UsageCode": "REQUISITIONING", "Usage": "Requisitioning", "SecuredByCode": "SECURED_BY_WORKER", "SecuredBy": "Workers", "CreationDate": "2023-11-01T16:15:23.188+00:00", "CreatedBy": "CVBUYER01", "LastUpdatedBy": "CVBUYER01", "LastUpdatedDate": "2023-11-01T16:15:23.188+00:00" }