機械翻訳について

ジャンプ先

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

参照の作成

post

/crmRestApi/resources/11.13.18.05/dynamicLinkValues

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• BUOrgId: integer (int64)
  タイトル: Business Unit ID

  デジタル・カスタマ・ポータルにマップされたビジネス・ユニットの一意の識別子。
• BusinessUnitName: string
  タイトル: Business Unit Name

  最大長: 240

  デジタル・カスタマ・ポータルにマップされたビジネス・ユニットの名前。
• CustomerPortalURL: string
  タイトル: External URL

  最大長: 1024

  デジタル・カスタマ・ポータルのURL。
• InternalURL: string
  タイトル: Internal URL

  最大長: 1024

  実装会社の内部アプリケーションを使用して動的リンクを開くための内部URL。
• ObjectType: string
  タイトル: Object Type

  動的リンク値のオブジェクト・タイプ。
• ObjectTypeId: integer (int64)
  タイトル: Object Type ID

  動的リンク値のオブジェクト・タイプID。
• ObjectVersionNumber: 整数(int32)
  動的リンク値のオブジェクト・バージョン番号。
• Pattern: string
  タイトル: Pattern

  動的リンク値のパターン。
• PatternPrefix: string
  タイトル: Pattern Beginning

  動的リンク値のパターン・プレフィクス。
• PatternSuffix: string
  タイトル: Pattern Ending

  動的リンク値のパターンサフィクス。

{
    "type":"object",
    "properties":{
        "InternalURL":{
            "title":"Internal URL",
            "maxLength":1024,
            "type":"string",
            "description":"The internal URL for opening dynamic links using an internal application of the implementing company.",
            "nullable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "type":"string",
            "description":"The object type of dynamic link value.",
            "nullable":true
        },
        "Pattern":{
            "title":"Pattern",
            "type":"string",
            "description":"The pattern of dynamic link value.",
            "nullable":true
        },
        "PatternSuffix":{
            "title":"Pattern Ending",
            "type":"string",
            "description":"The pattern suffix of dynamic link value.",
            "nullable":true
        },
        "PatternPrefix":{
            "title":"Pattern Beginning",
            "type":"string",
            "description":"The pattern prefix of dynamic link value.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of dynamic link value.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ObjectTypeId":{
            "title":"Object Type ID",
            "type":"integer",
            "description":"The object type ID of dynamic link value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit mapped to Digital Customer Portal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit mapped to Digital Customer Portal.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CustomerPortalURL":{
            "title":"External URL",
            "maxLength":1024,
            "type":"string",
            "description":"The URL to the Digital Customer Portal.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• BUOrgId: integer (int64)
  タイトル: Business Unit ID

  デジタル・カスタマ・ポータルにマップされたビジネス・ユニットの一意の識別子。
• BusinessUnitName: string
  タイトル: Business Unit Name

  最大長: 240

  デジタル・カスタマ・ポータルにマップされたビジネス・ユニットの名前。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  リンク・レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  リンク・レコードが作成された日付
• CustomerPortalURL: string
  タイトル: External URL

  最大長: 1024

  デジタル・カスタマ・ポータルのURL。
• InternalURL: string
  タイトル: Internal URL

  最大長: 1024

  実装会社の内部アプリケーションを使用して動的リンクを開くための内部URL。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  リンク・レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  リンク・レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  リンク・レコードを最後に更新したユーザーのログイン詳細。
• LinkId: integer (int64)
  タイトル: Link ID

  読取り専用: true

  動的リンク値の一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectType: string
  タイトル: Object Type

  動的リンク値のオブジェクト・タイプ。
• ObjectTypeId: integer (int64)
  タイトル: Object Type ID

  動的リンク値のオブジェクト・タイプID。
• ObjectVersionNumber: 整数(int32)
  動的リンク値のオブジェクト・バージョン番号。
• Pattern: string
  タイトル: Pattern

  動的リンク値のパターン。
• PatternPrefix: string
  タイトル: Pattern Beginning

  動的リンク値のパターン・プレフィクス。
• PatternSuffix: string
  タイトル: Pattern Ending

  動的リンク値のパターンサフィクス。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the link record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the link record was created",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Pattern":{
            "title":"Pattern",
            "type":"string",
            "description":"The pattern of dynamic link value.",
            "nullable":true,
            "x-queryable":true
        },
        "PatternSuffix":{
            "title":"Pattern Ending",
            "type":"string",
            "description":"The pattern suffix of dynamic link value.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the link record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalURL":{
            "title":"Internal URL",
            "maxLength":1024,
            "type":"string",
            "description":"The internal URL for opening dynamic links using an internal application of the implementing company.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "type":"string",
            "description":"The object type of dynamic link value.",
            "nullable":true,
            "x-queryable":true
        },
        "PatternPrefix":{
            "title":"Pattern Beginning",
            "type":"string",
            "description":"The pattern prefix of dynamic link value.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of dynamic link value.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectTypeId":{
            "title":"Object Type ID",
            "type":"integer",
            "description":"The object type ID of dynamic link value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit mapped to Digital Customer Portal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit mapped to Digital Customer Portal.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CustomerPortalURL":{
            "title":"External URL",
            "maxLength":1024,
            "type":"string",
            "description":"The URL to the Digital Customer Portal.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkId":{
            "title":"Link ID",
            "type":"integer",
            "description":"The unique identifier of the dynamic link value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the link record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the link record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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."
        }
    }
}

「トップに戻る」