機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

契約パーティ担当の取得

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact/{ContractPartyContactUniqID}

リクエスト

パス・パラメータ

• ContractPartyContactUniqID(required): string
  これは、契約パーティ担当者リソースの複合キー(IDおよびMajorVersion ---)を構成する属性のハッシュ・キーで、契約パーティ担当者のインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、契約パーティ担当者の特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用して契約パーティ担当者コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: ContractPartyContact?q=Id=<value1>;MajorVersion=<value2>
• ContractPartyUniqID(required): string
  これは、契約パーティ・リソースの複合キー(IDおよびMajorVersion ---)を構成する属性のハッシュ・キーで、契約パーティのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、契約パーティの特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用して契約パーティ・コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: ContractParty?q=Id=<value1>;MajorVersion=<value2>
• 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
• 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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : contracts-ContractParty-ContractPartyContact-item-response

タイプ: object

ソースを表示

• AccessLevel: string
  タイトル: Access

  最大長: 30

  契約パーティ担当者のアクセス・レベル。
• AccessLevelName: string
  契約パーティ担当者のアクセス・レベルの名前。
• ContactId: integer (int64)
  担当者の一意の識別子。
• ContactPuid: string
  タイトル: Party Contact PUID

  最大長: 120

  担当者PUID
• ContactRoleCode: string
  タイトル: Role

  最大長: 30

  契約パーティ担当者のロールを示すコード。
• ContractPartyContactFlexfieldVA: array Contract Party Contact Flexfields
  タイトル: Contract Party Contact Flexfields

  契約パーティ担当者フレックス・フィールド・リソースは、契約パーティ担当者フレックス・フィールド情報を表示、作成、更新するために使用します。
• EndDate: 文字列(日付)
  タイトル: End Date

  終了日
• ExternalKey: string
  最大長: 120

  外部ソース・システムの契約パーティ担当者のキー識別子。
• ExternalSource: string
  最大長: 120

  契約パーティ担当者のインポート元となる外部ソース・システムの名前。
• Id: integer (int64)
  契約パーティ担当の一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MajorVersion: integer (int64)
  デフォルト値: 1

  契約パーティ担当者のバージョン。
• OwnerFlag: boolean
  タイトル: Owner

  担当者が契約の所有者であるかどうかを示します。
• PartyContactName: string
  契約パーティ担当者の名前。
• Role: string
  契約パーティ担当者のロール。
• RoutingSequence: number
  タイトル: Signing Sequence

  署名順序
• SignatureRole: string
  タイトル: Signature Role

  最大長: 30

  署名者ロール・コード
• SignatureRoleMeaning: string
  署名者ロール
• SignerSequence: integer
  タイトル: Display Sequence

  歌手シーケンス
• StartDate: 文字列(日付)
  タイトル: Start Date

  開始日

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "type":"integer",
            "description":"The version of the contract party contact.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactRoleCode":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the role of the contract party contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccessLevelName":{
            "type":"string",
            "description":"The name of the access level of the contract party contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RoutingSequence":{
            "title":"Signing Sequence",
            "type":"number",
            "description":"Signing Sequence",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"indicates whether the contact is the owner of the contract.",
            "nullable":true,
            "x-queryable":true
        },
        "SignerSequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Singer Sequence",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyContactName":{
            "type":"string",
            "description":"The name of the contract party contact.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AccessLevel":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The access level of a contract party contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContractPartyContactFlexfieldVA":{
            "title":"Contract Party Contact Flexfields",
            "type":"array",
            "description":"The contract party contact flex field resource is used to view, create, update contract party contact flex field information.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response"
            },
            "x-cardinality":"1"
        },
        "Role":{
            "type":"string",
            "description":"The role of the contract party contact.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SignatureRoleMeaning":{
            "type":"string",
            "description":"Signatory Role",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalSource":{
            "maxLength":120,
            "type":"string",
            "description":"The name of external source system where the contract party contact is imported from.",
            "nullable":true,
            "x-queryable":true
        },
        "SignatureRole":{
            "title":"Signature Role",
            "maxLength":30,
            "type":"string",
            "description":"Signatory Role Code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactPuid":{
            "title":"Party Contact PUID",
            "maxLength":120,
            "type":"string",
            "description":"Contact PUID",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"The key identifier of the contract party contact in the external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the contract party contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 契約パーティ担当者フレックスフィールド

タイプ: array

タイトル: Contract Party Contact Flexfields

契約パーティ担当者フレックス・フィールド・リソースは、契約パーティ担当者フレックス・フィールド情報を表示、作成、更新するために使用します。

ソースを表示

• Array of: object contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response

{
    "title":"Contract Party Contact Flexfields",
    "type":"array",
    "description":"The contract party contact flex field resource is used to view, create, update contract party contact flex field information.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response"
    },
    "x-cardinality":"1"
}

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

タイプ: 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-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response

タイプ: object

ソースを表示

• __FLEX_Context: string
  タイトル: Context Segment

  最大長: 90

  付加フレックスフィールド: ユーザー付加フレックスフィールドの構造定義です。
• __FLEX_Context_DisplayValue: string
  タイトル: Context Segment
• Id: integer (int64)
  契約パーティ担当者フレックスフィールドID
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MajorVersion: integer (int64)
  デフォルト値: 1

  メジャー・バージョン

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "type":"integer",
            "description":"Major Version",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"Contract Party Contact Flexfield ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":90,
            "type":"string",
            "description":"Descriptive Flexfield: structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

リンク

ContractPartyContactFlexfieldVA

操作: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact/{ContractPartyContactUniqID}/child/ContractPartyContactFlexfieldVA

パラメータ:

• ContractPartyContactUniqID: $request.path.ContractPartyContactUniqID
• ContractPartyUniqID: $request.path.ContractPartyUniqID
• contractsUniqID: $request.path.contractsUniqID

契約パーティ担当者フレックスフィールド要素

「トップに戻る」