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

機械翻訳について

オブジェクト・リンク・タイプの作成

post

/crmRestApi/resources/11.13.18.05/objectLinkTypes

リクエスト

ヘッダー・パラメータ

Metadata-Context:

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

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

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

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

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

タイプ: object

ソースを表示

EnabledFlag: boolean

タイトル: Enabled

最大長: 1

デフォルト値: true

リンク・タイプを使用してオブジェクト・リンクを作成できるかどうかを示します。
InwardCd: string

タイトル: Inward

最大長: 30

リンク・タイプの内向方向を記述する参照コード。このフィールドは、短縮名に指定された値から自動生成されます。
InwardCdMeaning: string

タイトル: Inward Value

最大長: 80

内部参照コードの表示値。
LinkTypeNumber: string

タイトル: Link Type Number

最大長: 64

オブジェクト・リンク・タイプの参照番号。
Name: string

タイトル: Name

最大長: 400

リンク・タイプのわかりやすい名前。
OutwardCd: string

タイトル: Outward

最大長: 30

リンク・タイプの外部方向を説明する参照コード。このフィールドは、短縮名に指定された値から自動生成されます。
OutwardCdMeaning: string

タイトル: Outward Value

最大長: 80

外部参照コードの表示値。
ShortName: string

タイトル: Short Name

最大長: 20

リンク・タイプの一意の名前。外側コードと内側コードは短縮名に基づいて自動生成されます。

{
    "type":"object",
    "properties":{
        "InwardCd":{
            "title":"Inward",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that describes the inward direction of a link type. This field is auto generated from the value provided for short name.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LinkTypeNumber":{
            "title":"Link Type Number",
            "maxLength":64,
            "type":"string",
            "description":"The reference number of the object link type.",
            "nullable":false
        },
        "InwardCdMeaning":{
            "title":"Inward Value",
            "maxLength":80,
            "type":"string",
            "description":"The display value of the inward lookup code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "InwardCd"
                ]
            }
        },
        "ShortName":{
            "title":"Short Name",
            "maxLength":20,
            "type":"string",
            "description":"A unique name for the link type. The outward and inward codes are auto generated based on the short name.",
            "nullable":false
        },
        "OutwardCd":{
            "title":"Outward",
            "maxLength":30,
            "type":"string",
            "description":"Lookup code that describes the outward direction of a link type. This field is auto generated from the value provided for short name.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the link type can be used to create object links with.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "OutwardCdMeaning":{
            "title":"Outward Value",
            "maxLength":80,
            "type":"string",
            "description":"The display value of the outward lookup code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "OutwardCd"
                ]
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"A descriptive name for the link type.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行が作成された日付。
DeleteFlag: boolean

読取り専用: true

ユーザーがレコードを削除できるかどうかを示します。
EnabledFlag: boolean

タイトル: Enabled

最大長: 1

デフォルト値: true

リンク・タイプを使用してオブジェクト・リンクを作成できるかどうかを示します。
InwardCd: string

タイトル: Inward

最大長: 30

リンク・タイプの内向方向を記述する参照コード。このフィールドは、短縮名に指定された値から自動生成されます。
InwardCdMeaning: string

タイトル: Inward Value

最大長: 80

内部参照コードの表示値。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

オブジェクト・リンク・タイプが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

オブジェクト・リンク・タイプを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

行を最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Link Type ID

読取り専用: true

リンク・タイプ識別子。
LinkTypeNumber: string

タイトル: Link Type Number

最大長: 64

オブジェクト・リンク・タイプの参照番号。
Name: string

タイトル: Name

最大長: 400

リンク・タイプのわかりやすい名前。
OutwardCd: string

タイトル: Outward

最大長: 30

リンク・タイプの外部方向を説明する参照コード。このフィールドは、短縮名に指定された値から自動生成されます。
OutwardCdMeaning: string

タイトル: Outward Value

最大長: 80

外部参照コードの表示値。
ShortName: string

タイトル: Short Name

最大長: 20

リンク・タイプの一意の名前。外側コードと内側コードは短縮名に基づいて自動生成されます。
UpdateFlag: boolean

読取り専用: true

ユーザーがレコードを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LinkTypeId":{
            "title":"Link Type ID",
            "type":"integer",
            "description":"The link type identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the object link type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InwardCd":{
            "title":"Inward",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that describes the inward direction of a link type. This field is auto generated from the value provided for short name.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InwardCdMeaning":{
            "title":"Inward Value",
            "maxLength":80,
            "type":"string",
            "description":"The display value of the inward lookup code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "InwardCd"
                ]
            }
        },
        "ShortName":{
            "title":"Short Name",
            "maxLength":20,
            "type":"string",
            "description":"A unique name for the link type. The outward and inward codes are auto generated based on the short name.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the user can delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"A descriptive name for the link type.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the user can update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "LinkTypeNumber":{
            "title":"Link Type Number",
            "maxLength":64,
            "type":"string",
            "description":"The reference number of the object link type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OutwardCd":{
            "title":"Outward",
            "maxLength":30,
            "type":"string",
            "description":"Lookup code that describes the outward direction of a link type. This field is auto generated from the value provided for short name.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the link type can be used to create object links with.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "OutwardCdMeaning":{
            "title":"Outward Value",
            "maxLength":80,
            "type":"string",
            "description":"The display value of the outward lookup code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "OutwardCd"
                ]
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the object link type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the row.",
            "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."
        }
    }
}

リンク

DirectionCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_LINK_DIRECTION_CD

オブジェクト・リンク・タイプの内部オブジェクト・リンク・タイプ・コードを示す値リスト。

YesNoLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DYES_NO

オブジェクト・リンク・タイプの有効プロパティを示す値リスト。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するポスト・リクエストを発行して、オブジェクト・リンク・タイプを作成する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/

リクエスト本文の例

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

{
"Name": "Beta",
"ShortName": "BETA",
"OutwardCd": "BETA",
"OutwardCdMeaning": "Beta Relation",
"InwardCdMeaning": "Beta Inverse Relation"
}

レスポンス本文の例

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

{
    "LinkTypeId": 300100548010602,
    "LinkTypeNumber": "CDRM_4006",
    "Name": "Beta",
    "ShortName": "BETA",
    "OutwardCd": "BETA",
    "InwardCd": "BETA_I",
    "EnabledFlag": true,
    "CreationDate": "2021-08-19T05:46:43+00:00",
    "CreatedBy": "MHoope",
    "LastUpdateDate": "2021-08-19T05:46:44.947+00:00",
    "LastUpdatedBy": "MHoope",
    "LastUpdateLogin": "C963056652A5354FE0531C5CF00A431D",
    "OutwardCdMeaning": "Beta Relation",
    "InwardCdMeaning": "Beta Inverse Relation",
    "UpdateFlag": true,
    "DeleteFlag": true,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/CDRM_4006",
            "name": "objectLinkTypes",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/objectLinkTypes/CDRM_4006",
            "name": "objectLinkTypes",
            "kind": "item"
        }
    ]
}

ノート:

オブジェクト・リンク・タイプの作成時にShortNameの値を指定し、検証ShortName=OutwardCdを指定する必要があります。

「トップに戻る」