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

機械翻訳について

関連文書の作成

post

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RelatedDocument

リクエスト

パス・パラメータ

contractsUniqID(required): string

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

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

Attribute26: string

最大長: 150

attribute26。
ChrId: integer (int64)

契約ID
CleId: integer (int64)

契約明細ID
ContractNumber: string

タイトル: Document Reference

最大長: 120

関連契約番号
CreateEnableFlag: boolean

create enableフラグ。
DeleteEnableFlag: boolean

削除の有効化フラグ。
DocumentTypeNew: string

タイトル: Document Type

文書タイプ新規です。
ExternalKey: string

最大長: 120

外部キー
ExternalSource: string

最大長: 120

外部ソース
Id: integer (int64)

関連文書ID
IntentMeaning: string

タイトル: Intent

最大長: 80

インテント。
JtotObject1Code: string

最大長: 30

デフォルト値: OKX_ECMCONTRACT

jtot object1コード。
RelatedContractId: integer (int64)

タイトル: Document Reference

関連契約ID
RelatedObjPuid: string

タイトル: Related Object PUID

最大長: 120

関連するオブジェクトPUID。
Relationship: string

関係名
RelationshipCode: string

タイトル: Relationship

最大長: 30

関係コード

{
    "type":"object",
    "properties":{
        "IntentMeaning":{
            "title":"Intent",
            "maxLength":80,
            "type":"string",
            "description":"The intent.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractNumber":{
            "title":"Document Reference",
            "maxLength":120,
            "type":"string",
            "description":"Related Contract Number",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ChrId":{
            "type":"integer",
            "description":"The contract ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CreateEnableFlag":{
            "type":"boolean",
            "description":"The create enable flag.",
            "nullable":true,
            "x-queryable":false
        },
        "Attribute26":{
            "maxLength":150,
            "type":"string",
            "description":"The attribute26.",
            "nullable":true
        },
        "CleId":{
            "type":"integer",
            "description":"The contract line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "JtotObject1Code":{
            "maxLength":30,
            "type":"string",
            "description":"The jtot object1 code.",
            "nullable":false,
            "default":"OKX_ECMCONTRACT"
        },
        "DeleteEnableFlag":{
            "type":"boolean",
            "description":"The delete enable flag.",
            "nullable":true,
            "x-queryable":false
        },
        "RelationshipCode":{
            "title":"Relationship",
            "maxLength":30,
            "type":"string",
            "description":"Relationship Code",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExternalSource":{
            "maxLength":120,
            "type":"string",
            "description":"External Source",
            "nullable":true
        },
        "Relationship":{
            "type":"string",
            "description":"Relationship name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelatedObjPuid":{
            "title":"Related Object PUID",
            "maxLength":120,
            "type":"string",
            "description":"The related obj PUID.",
            "nullable":true
        },
        "RelatedContractId":{
            "title":"Document Reference",
            "type":"integer",
            "description":"Related Contract ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"External Key",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"Related Document ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DocumentTypeNew":{
            "title":"Document Type",
            "type":"string",
            "description":"The document type new.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

Attribute26: string

最大長: 150

attribute26。
BuyOrSell: string

タイトル: Intent

読取り専用: true

最大長: 3

目的フラグ。
ChrId: integer (int64)

契約ID
CleId: integer (int64)

契約明細ID
Cognomen: string

タイトル: Name

読取り専用: true

最大長: 300

契約名。
ContractHeaderId: integer (int64)

読取り専用: true

契約ヘッダーID。
ContractId: integer (int64)

読取り専用: true

関連文書一意ID
ContractMajorVersion: integer (int64)

タイトル: Version

読取り専用: true

デフォルト値: 1

契約メジャー・バージョン。
ContractNumber: string

タイトル: Document Reference

最大長: 120

関連契約番号
ContractTypeDescription: string

読取り専用: true

最大長: 1995

契約タイプ摘要。
ContractTypeId: integer

読取り専用: true

契約タイプID。
CreateEnableFlag: boolean

create enableフラグ。
CurrencyCode: string

タイトル: Currency

読取り専用: true

最大長: 15

通貨コード。
DeleteEnableFlag: boolean

削除の有効化フラグ。
Description: string

タイトル: Description

読取り専用: true

最大長: 1995

摘要
DocumentTypeNew: string

タイトル: Document Type

文書タイプ新規です。
EndDate: 文字列(日付)

タイトル: End Date

読取り専用: true

終了日。
EstimatedAmount: number

タイトル: Amount

読取り専用: true

デフォルト値: 0

見積金額。
ExternalKey: string

最大長: 120

外部キー
ExternalSource: string

最大長: 120

外部ソース
Id: integer (int64)

関連文書ID
IntentMeaning: string

タイトル: Intent

最大長: 80

インテント。
JtotObject1Code: string

最大長: 30

デフォルト値: OKX_ECMCONTRACT

jtot object1コード。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectVersionNumber1: 整数(int32)

読取り専用: true

オブジェクト・バージョンnumber1。
ObjectVersionNumber2: 整数(int32)

読取り専用: true

オブジェクト・バージョンnumber2。
OrgName: string

読取り専用: true

組織名。
RelatedContractId: integer (int64)

タイトル: Document Reference

関連契約ID
RelatedObjPuid: string

タイトル: Related Object PUID

最大長: 120

関連するオブジェクトPUID。
Relationship: string

関係名
RelationshipCode: string

タイトル: Relationship

最大長: 30

関係コード
StartDate: 文字列(日付)

タイトル: Start Date

読取り専用: true

開始日。
StsCode: string

タイトル: Status

読取り専用: true

最大長: 30

デフォルト値: DRAFT

ステータス・コード。
Type: string

読取り専用: true

最大長: 150

タイプ。

{
    "type":"object",
    "properties":{
        "ContractTypeDescription":{
            "maxLength":1995,
            "type":"string",
            "description":"The contract type description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntentMeaning":{
            "title":"Intent",
            "maxLength":80,
            "type":"string",
            "description":"The intent.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractNumber":{
            "title":"Document Reference",
            "maxLength":120,
            "type":"string",
            "description":"Related Contract Number",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1995,
            "type":"string",
            "description":"The description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuyOrSell":{
            "title":"Intent",
            "maxLength":3,
            "type":"string",
            "description":"The intent flag.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContractTypeId":{
            "type":"integer",
            "description":"The contract type ID.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstimatedAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The estimated amount.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "OrgName":{
            "type":"string",
            "description":"The org name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractMajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"The contract major version.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractHeaderId":{
            "type":"integer",
            "description":"The contract header ID.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StsCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code.",
            "nullable":false,
            "readOnly":true,
            "default":"DRAFT",
            "x-queryable":true
        },
        "CleId":{
            "type":"integer",
            "description":"The contract line ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteEnableFlag":{
            "type":"boolean",
            "description":"The delete enable flag.",
            "nullable":true,
            "x-queryable":false
        },
        "RelationshipCode":{
            "title":"Relationship",
            "maxLength":30,
            "type":"string",
            "description":"Relationship Code",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExternalSource":{
            "maxLength":120,
            "type":"string",
            "description":"External Source",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedContractId":{
            "title":"Document Reference",
            "type":"integer",
            "description":"Related Contract ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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":"External Key",
            "nullable":true,
            "x-queryable":true
        },
        "ChrId":{
            "type":"integer",
            "description":"The contract ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractId":{
            "type":"integer",
            "description":"Related Document Unique ID",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber2":{
            "type":"integer",
            "description":"The object version number2.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CreateEnableFlag":{
            "type":"boolean",
            "description":"The create enable flag.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"The object version number1.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Attribute26":{
            "maxLength":150,
            "type":"string",
            "description":"The attribute26.",
            "nullable":true,
            "x-queryable":true
        },
        "Type":{
            "maxLength":150,
            "type":"string",
            "description":"The type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JtotObject1Code":{
            "maxLength":30,
            "type":"string",
            "description":"The jtot object1 code.",
            "nullable":false,
            "default":"OKX_ECMCONTRACT",
            "x-queryable":true
        },
        "Relationship":{
            "type":"string",
            "description":"Relationship name",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelatedObjPuid":{
            "title":"Related Object PUID",
            "maxLength":120,
            "type":"string",
            "description":"The related obj PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"Related Document ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentTypeNew":{
            "title":"Document Type",
            "type":"string",
            "description":"The document type new.",
            "nullable":true,
            "x-queryable":false
        },
        "Cognomen":{
            "title":"Name",
            "maxLength":300,
            "type":"string",
            "description":"The contract name.",
            "nullable":true,
            "readOnly":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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する投稿リクエストを発行することによって、関連ドキュメントを作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/latest/contracts/100100069430785/child/RelatedDocument

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{ 
   "RelationshipCode": "GOVERNED_BY",
   "RelatedContractId": 300100169111391
   }

レスポンス本文の例

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

{
    "Id": 300100207710059,
    "ChrId": 999990000000147,
    "CleId": null,
    "RelationshipCode": "GOVERNED_BY",
    "Relationship": "Governed by",
    "JtotObject1Code": "OKX_ECMCONTRACT",
    "RelatedContractId": 300100169111391,
    "Attribute26": null,
    "ContractHeaderId": null,
    "ContractNumber": null,
    "BuyOrSell": null,
    "ContractMajorVersion": null,
    "ContractTypeDescription": null,
    "ContractTypeId": null,
    "ExternalSource": null,
    "ExternalKey": null,
    "CreateEnableFlag": "true",
    "DeleteEnableFlag": "true",
    "DocumentTypeNew": null,
    "IntentMeaning": null,
    "ContractId": null,
    "CurrencyCode": null,
    "ObjectVersionNumber1": null,
    "StartDate": null,
    "ObjectVersionNumber2": null,
    "EndDate": null,
    "EstimatedAmount": null,
    "Cognomen": null,
    "Description": null,
    "StsCode": null,
    "OrgName": null,
    "Type": null,
    "RelatedObjPuid": "KHDR-63-1-ROBJ-554002",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/300100207710059",
            "name": "RelatedDocument",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/300100207710059",
            "name": "RelatedDocument",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785",
            "name": "contracts",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/300100207710059/lov/IntentLookupVO1",
            "name": "IntentLookupVO1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/300100207710059/lov/RelationshipLookupVA1",
            "name": "RelationshipLookupVA1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430785/child/RelatedDocument/300100207710059/lov/ContractNumberVA",
            "name": "ContractNumberVA",
            "kind": "collection"
        }
    ]
}

「トップに戻る」