Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべての関連プロジェクトの取得

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/AssociatedProject

リクエスト

パス・パラメータ

LineId(required): integer(int64)

契約明細の一意の識別子。
contractsUniqID(required): string

これは、Contractsリソースの複合キーを構成し、Contractsのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、Contractsの特定のインスタンスに移動してハッシュ・キーを取得するために、Contractsコレクション・リソースを問い合せる必要があります。

問合せパラメータ

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
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- AssociatedProjectExtAltKey : 外部代替キーとのプロジェクト関連付けを検索します。
  ファインダ変数:
  - ExternalReferenceKey; string.
  - ExternalSourceKey; string.
- PrimaryKey : 指定されたプロジェクト関連付けIDおよびメジャー・バージョンを持つ関連プロジェクトを検索します。
  ファインダ変数:
  - LinkId; integer;プロジェクト関連付け識別子。
  - MajorVersion; integer;プロジェクト関連付けメジャー・バージョン。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- ActiveFlag; boolean;リンクがまだ有効かどうかをチェックするフラグ
- ExternalReferenceKey; string;外部ソース内の参照キー
- ExternalSourceKey; string;外部ソース・キー
- FundingAmount;番号;リンケージ資金額
- LastRevRecogDate; string;この契約明細内のこの関連プロジェクトについて、収益が最後に認識された日付。
- LinkId; integer;契約プロジェクト・リンケージの一意の識別子。
- MajorVersion; integer;リンケージが定義されている契約バージョン
- PercentComplete;数値;完了率
- ProjElementId; integer;リンケージ上のタスクのタスク識別子
- ProjectId; integer;リンケージ上のプロジェクトのプロジェクト識別子
- ProjectNumber; string; Linkage上のプロジェクトのプロジェクト番号
- TaskNumber; string;リンケージ上のタスクのタスク番号
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

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

ルート・スキーマ : contracts-ContractLine-AssociatedProject

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

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

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractLine-AssociatedProject-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object contracts-ContractLine-AssociatedProject-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractLine-AssociatedProject-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : contracts-ContractLine-AssociatedProject-item-response

タイプ: object

ソースを表示

ActiveFlag: boolean

タイトル: Active

最大長: 1

デフォルト値: true

リンクがまだ有効かどうかを確認するフラグ
CurrencyCode: string

タイトル: Contract Currency

通貨コード。
ExternalReferenceKey: string

タイトル: External Reference Key

最大長: 150

外部ソースの参照キー
ExternalSourceKey: string

タイトル: External Source Key

最大長: 150

外部ソース・キー
FundingAmount: number

タイトル: Contract Funding

リンケージ資金額
LastRevRecogDate: 文字列(日付)

タイトル: Last Revenue Recognized Date

読取り専用: true

この契約明細内のこの関連プロジェクトについて、収益が最後に認識された日付。
LinkId: integer (int64)

タイトル: Contract Project Association ID

契約プロジェクト・リンケージの一意の識別子。
links: array Links

タイトル: Links

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

タイトル: Version

リンケージが定義されている契約バージョン
PercentComplete: number

タイトル: Percent Complete

完了率
ProjectId: integer (int64)

タイトル: Project ID

リンク上のプロジェクトのプロジェクト識別子
ProjectNumber: string

タイトル: Project Number

最大長: 25

リンク上のプロジェクトのプロジェクト番号
ProjElementId: integer (int64)

タイトル: Project Task ID

リンケージのタスクのタスク識別子
TaskNumber: string

タイトル: Task Number

最大長: 100

リンク上のタスクのタスク番号

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Contract Version on which linkage is defined",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":150,
            "type":"string",
            "description":"Reference key in External source",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":150,
            "type":"string",
            "description":"External Source Key",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "description":"Project Number of the project on Linkage",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "LastRevRecogDate":{
            "title":"Last Revenue Recognized Date",
            "type":"string",
            "description":"The date revenue was last recognized for this associated project within this contract line.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Project Identifier for the project on Linkage",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"Task Number of the Task on the linkage",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ProjectId",
                    "ProjectNumber"
                ]
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to check if linkage is still valid",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Contract Currency",
            "type":"string",
            "description":"The currency code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ProjElementId":{
            "title":"Project Task ID",
            "type":"integer",
            "description":"Task Identifier for the the task on linkage",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ProjectId",
                    "ProjectNumber"
                ]
            },
            "x-queryable":true
        },
        "PercentComplete":{
            "title":"Percent Complete",
            "type":"number",
            "description":"Percentage Complete",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "FundingAmount":{
            "title":"Contract Funding",
            "type":"number",
            "description":"Linkage funding amount",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LinkId":{
            "title":"Contract Project Association ID",
            "type":"integer",
            "description":"The unique identifier of the Contract project linkage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

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

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

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

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

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

「トップに戻る」