Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

ショッピング・リストを1つ取得

get

/fscmRestApi/resources/11.13.18.05/shoppingLists/{shoppingListsUniqID}

リクエスト

パス・パラメータ

shoppingListsUniqID(required): string

これは、ショッピング・リスト・リソースに対する複合キー(ShoppingListHeaderIdおよびShoppingListType)を構成する属性のハッシュ・キーで、ショッピング・リストのインスタンスを一意に識別するために使用されます。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、ショッピング・リストの特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用してショッピング・リスト・コレクション・リソースを問い合せる必要があります。

次に例を示します: shoppingLists?q=ShoppingListHeaderId=<value1>;ShoppingListType=<value2>

問合せパラメータ

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のデフォルト・バージョンを選択します。

ルート・スキーマ : shoppingLists-item-response

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

ショッピング・リストを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

ユーザーがショッピング・リストを作成した日時。
ImageURL: string

読取り専用: true

最大長: 1000

ショッピング・リストを表すイメージを特定するURL。
LastUpdateDate: string (date-time)

読取り専用: true

ユーザーがショッピング・リストを最後に更新した日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

ショッピング・リストを最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ShoppingList: string

タイトル: Shopping List

読取り専用: true

最大長: 100

ショッピング・リストの名前。
ShoppingListDescription: string

タイトル: Shopping List Description

読取り専用: true

最大長: 250

ショッピング・リストの説明。
ShoppingListHeaderId: integer (int64)

読取り専用: true

ショッピング・リストを一意に識別する値。
ShoppingListType: string

タイトル: Shopping List Type

読取り専用: true

最大長: 6

ショッピング・リストのタイプを示す値です。有効な値は、PUBLICまたはPERSONALです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the shopping list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the shopping list.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the shopping list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShoppingList":{
            "title":"Shopping List",
            "maxLength":100,
            "type":"string",
            "description":"Name of the shopping list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShoppingListType":{
            "title":"Shopping List Type",
            "maxLength":6,
            "type":"string",
            "description":"Value that indicates the type of the shopping list. Valid values are PUBLIC or PERSONAL.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ImageURL":{
            "maxLength":1000,
            "type":"string",
            "description":"URL that locates the image representing the shopping list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ShoppingListDescription":{
            "title":"Shopping List Description",
            "maxLength":250,
            "type":"string",
            "description":"Description of the shopping list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShoppingListHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shopping list.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the shopping list.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

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

ネストされたスキーマ : プロパティ

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例

この例では、1つのショッピング・リストを取得する方法を説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:

curl -u username:password "https://servername/fscmRestApi/resources/version/shoppingLists/shoppingListsUniqID"

ノート:

shoppingListsUniqIDは、ショッピング・リスト・リソースのコンポジット・キーShoppingListHeaderIdおよびShoppingListTypeを構成する属性のハッシュ・キーです。ショッピング・リストのインスタンスを一意に識別するために使用されます。ハッシュ・キー値は生成しないでください。かわりに、ファインダを使用してショッピング・リスト・コレクション・リソースを問い合せて、ショッピング・リストの特定のインスタンスに移動する必要があります。

次に例を示します: shoppingLists?finder=findByRequisitioningBUAndShoppingList;RequisitioningBUId=<value1>,ShoppingListName=<value2>

たとえば、次のコマンドは、ショッピング・リストの一意識別子が00020000000EACED00057708000110F09B98E1CD000000065055424C4943であるショッピング・リストを取得

curl -u username:password "https://servername/fscmRestApi/resources/version/shoppingLists/00020000000EACED00057708000110F09B98E1CD000000065055424C4943"

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{
    "ShoppingListHeaderId": 300100565393869,
    "ShoppingList": "Cardiology Department - Angioplasty & Stent Placement Surgery Supplies and Equipment",
    "ShoppingListDescription": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
    "ShoppingListType": "PUBLIC",
    "ImageURL": null,
    "CreationDate": "2022-10-31T08:06:09.267+00:00",
    "CreatedBy": "CVBUYER01",
    "LastUpdatedBy": "CVBUYER01",
    "LastUpdateDate": "2022-10-31T08:06:10.019+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/shoppingLists/00020000000EACED00057708000110F09B98E1CD000000065055424C4943",
            "name": "shoppingLists",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/shoppingLists/00020000000EACED00057708000110F09B98E1CD000000065055424C4943",
            "name": "shoppingLists",
            "kind": "item"
        }
    ]
}

「トップに戻る」