Oracle Fusion Cloud ProcurementのREST API

1つの資格領域の取得

get

/fscmRestApi/resources/11.13.18.05/supplierInitiatives/{InitiativeId}/child/qualificationAreas/{InitiativeQualificationAreaId}

リクエスト

パス・パラメータ

InitiativeId(required): integer(int64)

イニシアチブを一意に識別する値です。
InitiativeQualificationAreaId(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のデフォルト・バージョンを選択します。

ルート・スキーマ : supplierInitiatives-qualificationAreas-item-response

タイプ: object

ソースを表示

DisplaySequence: integer (int32)

タイトル: Display Sequence

資格タイプのイニシアチブに追加された資格領域の順序を表示します。
EvaluationDueDate: string (date)

タイトル: Qualification Evaluation Due Date

資格が評価期日になった日付。
InitiativeQualificationAreaId: integer (int64)

資格領域を一意に識別する値です。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OriginalQualificationAreaId: integer (int64)

元の資格領域を一意に識別する値です。
Owner: string

タイトル: Owner

最大長: 240

資格領域所有者の名前。
OwnerId: integer (int64)

資格領域所有者の名前を一意に識別する値。
QualificationArea: string

タイトル: Qualification Area

最大長: 80

ユーザーが入力した資格領域の名前。
QualificationAreaDescription: string

タイトル: Description

読取り専用: true

最大長: 240

ユーザーが入力した資格領域の摘要。
QualificationAreaId: integer (int64)

資格領域を一意に識別する値です。
QualificationAreaRevision: integer (int32)

タイトル: Revision

読取り専用: true

資格領域定義の現在のバージョンを識別する番号。
QualificationAreaStatus: string

タイトル: Status

読取り専用: true

最大長: 80

資格領域のステータス。
QualificationAreaStatusCode: string

読取り専用: true

最大長: 30

資格領域のステータスを識別する略称です。使用可能な値のリストは、参照タイプPOQ_QUAL_AREA_STATUSで定義されます。設定およびメンテナンス作業領域および標準参照の管理タスクを使用して、この属性の値をレビューします。
SyncCheckFlag: boolean

タイトル: Synchronization Check

最大長: 1

サプライヤ属性質問の受理可能なレスポンスがサプライヤ・プロファイルと同期されているかどうかを示す値。次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、資格領域の同期チェックに合格しました。 falseの場合、資格領域の同期チェックに失敗しました。この属性にはデフォルト値がありません。

{
    "type":"object",
    "properties":{
        "Owner":{
            "title":"Owner",
            "maxLength":240,
            "type":"string",
            "description":"Name of the qualification area owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Display sequence of the qualification area added to a qualification kind of initiative.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "InitiativeQualificationAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the  qualification area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QualificationAreaStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the qualification area. A list of accepted values is defined in the lookup type POQ_QUAL_AREA_STATUS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "QualificationAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification area.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "QualificationArea":{
            "title":"Qualification Area",
            "maxLength":80,
            "type":"string",
            "description":"Name of the qualification area entered by the user.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EvaluationDueDate":{
            "title":"Qualification Evaluation Due Date",
            "type":"string",
            "description":"Date when the qualification was due for evaluation.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SyncCheckFlag":{
            "title":"Synchronization Check",
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether the acceptable response of a supplier attribute question is synchronized with supplier profile or not. Contains one of the following values: true or false. If true, then synchronization check has passed for qualification area. If false, then synchronization check has failed for the qualification area. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the name of the qualification area owner.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "OriginalQualificationAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the original qualification area.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QualificationAreaRevision":{
            "title":"Revision",
            "type":"integer",
            "description":"Number that identifies the current version of the qualification area definition.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "QualificationAreaDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the qualification area entered by user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QualificationAreaStatus":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the qualification area.",
            "nullable":false,
            "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/supplierInitiatives/InitiativeId/child/qualificationAreas/InitiativeQualificationAreaId"

たとえば、次のコマンドは1つの資格領域を取得します:

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/qualificationAreas/300100194001381"

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
	"InitiativeQualificationAreaId": 300100194001381,
	"SyncCheckFlag": true,
	"QualificationAreaId": 300100194001368,
	"QualificationArea": "Heavy Electricals Requirements",
	"OwnerId": 100010026864135,
	"Owner": "James,Penelope",
	"OriginalQualificationAreaId": 300100194001368,
	"EvaluationDueDate": "2020-02-29",
	"QualificationAreaDescription": null,
	"QualificationAreaRevision": 0,
	"QualificationAreaStatusCode": "ACTIVE",
	"QualificationAreaStatus": "Active",
	"DisplaySequence": 20,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/qualificationAreas/300100194001381",
		"name": "qualificationAreas",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/qualificationAreas/300100194001381",
		"name": "qualificationAreas",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373",
		"name": "supplierInitiatives",
		"kind": "item"
	}
	]
}

「トップに戻る」