機械翻訳について

ジャンプ先

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

リンクの作成

post

/crmRestApi/resources/11.13.18.05/resolutionLinks

リクエスト

ヘッダー・パラメータ

• 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

ソースを表示

• Description: string
  最大長: 240

  リンクの説明。
• LinkMember: array Link Members
  タイトル: Link Members

  リンク・メンバー・リソースは、リンクのメンバーを表示、作成および更新するために使用されます。
• LinkName: string
  最大長: 128

  リンクの名前。
• LinkNumber: string
  最大長: 64

  リンクの一意の識別子。
• LinkStatus: string
  最大長: 60

  デフォルト値: A

  リンクのステータス。 受け入れられる値のリストは、A (アクティブ)とI (非アクティブ)です。
• PartyType(required): string
  最大長: 30

  パーティが組織、個人、担当者またはその他のユーザー定義パーティ・タイプのいずれであるかを定義するパーティ・タイプです。

{
    "required":[
        "PartyType"
    ],
    "type":"object",
    "properties":{
        "LinkName":{
            "maxLength":128,
            "type":"string",
            "description":"The name of the link.",
            "nullable":true
        },
        "LinkStatus":{
            "maxLength":60,
            "type":"string",
            "description":"The status of a link. The list of accepted values are A (active) and I (inactive).",
            "nullable":false,
            "default":"A"
        },
        "LinkNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the link.",
            "nullable":false
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the link.",
            "nullable":true
        },
        "PartyType":{
            "maxLength":30,
            "type":"string",
            "description":"The party type that defines whether the party is an organization, a person, a contact or any other user-defined party type.",
            "nullable":false
        },
        "LinkMember":{
            "title":"Link Members",
            "type":"array",
            "description":"The link member resource is used to view, create, and update the members of a link.",
            "items":{
                "$ref":"#/components/schemas/resolutionLinks-LinkMember-item-post-request"
            }
        }
    }
}

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

タイプ: array

タイトル: Link Members

リンク・メンバー・リソースは、リンクのメンバーを表示、作成および更新するために使用されます。

ソースを表示

• Array of: object schema

{
    "title":"Link Members",
    "type":"array",
    "description":"The link member resource is used to view, create, and update the members of a link.",
    "items":{
        "$ref":"#/components/schemas/resolutionLinks-LinkMember-item-post-request"
    }
}

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

タイプ: object

ソースを表示

• MasterFlag: boolean
  最大長: 1

  リンクのマスター・メンバー。
• MemberStatus: string
  受け入れられる値のリンクmember.Theリストのステータスは、A (アクティブ)およびI (非アクティブ)です。
• PartyId: integer
  リンク・メンバーの一意の内部識別子。 リンクが関連付けられているリンク・メンバー・レコードを一意に識別するには、PartyIdまたはPartyNumberのいずれかが必要です。
• PartyName: string
  リンク・メンバーの名前。
• PartyNumber: string
  リンク・メンバーの一意のプライマリ識別子。

{
    "type":"object",
    "properties":{
        "PartyNumber":{
            "type":"string",
            "description":"The unique primary identifier for the link member.",
            "nullable":true
        },
        "PartyName":{
            "type":"string",
            "description":"The name of the link member.",
            "nullable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique internal identifier of a link member. Either PartyId or PartyNumber is required to uniquely identify the link member record with which the link is associated.",
            "nullable":true
        },
        "MemberStatus":{
            "type":"string",
            "description":"The status of a link member.The list of accepted values are A (active) and I (inactive).",
            "nullable":true,
            "x-queryable":false
        },
        "MasterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The master member of the link.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• CreatedBy: string
  読取り専用: true

  最大長: 64

  リンクを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  リンクが作成された日付。
• Description: string
  最大長: 240

  リンクの説明。
• LastUpdateDate: string (date-time)
  読取り専用: true

  リンクが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  リンクを最後に更新したユーザー。
• LinkId: integer (int64)
  読取り専用: true

  リンクの一意のプライマリ識別子。
• LinkMember: array Link Members
  タイトル: Link Members

  リンク・メンバー・リソースは、リンクのメンバーを表示、作成および更新するために使用されます。
• LinkName: string
  最大長: 128

  リンクの名前。
• LinkNumber: string
  最大長: 64

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

  リソース・インスタンスに関連付けられたリンク関係。
• LinkStatus: string
  最大長: 60

  デフォルト値: A

  リンクのステータス。 受け入れられる値のリストは、A (アクティブ)とI (非アクティブ)です。
• PartyType: string
  最大長: 30

  パーティが組織、個人、担当者またはその他のユーザー定義パーティ・タイプのいずれであるかを定義するパーティ・タイプです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the link.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkName":{
            "maxLength":128,
            "type":"string",
            "description":"The name of the link.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the link was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkStatus":{
            "maxLength":60,
            "type":"string",
            "description":"The status of a link. The list of accepted values are A (active) and I (inactive).",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the link.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the link.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkMember":{
            "title":"Link Members",
            "type":"array",
            "description":"The link member resource is used to view, create, and update the members of a link.",
            "items":{
                "$ref":"#/components/schemas/resolutionLinks-LinkMember-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LinkNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the link.",
            "nullable":false,
            "x-queryable":true
        },
        "LinkId":{
            "type":"integer",
            "description":"The unique primary identifier of the link.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyType":{
            "maxLength":30,
            "type":"string",
            "description":"The party type that defines whether the party is an organization, a person, a contact or any other user-defined party type.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the link was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Link Members

リンク・メンバー・リソースは、リンクのメンバーを表示、作成および更新するために使用されます。

ソースを表示

• Array of: object resolutionLinks-LinkMember-item-response

{
    "title":"Link Members",
    "type":"array",
    "description":"The link member resource is used to view, create, and update the members of a link.",
    "items":{
        "$ref":"#/components/schemas/resolutionLinks-LinkMember-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"
    }
}

ネストされたスキーマ : resolutionLinks-LinkMember-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  読取り専用: true

  最大長: 64

  リンク・メンバーを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  リンク・メンバーが作成された日付。
• DepartureDate: 文字列(日付)
  読取り専用: true

  メンバーがリンクから削除された日付。
• JoinDate: 文字列(日付)
  読取り専用: true

  メンバーがリンクに参加した日付。
• LastUpdateDate: string (date-time)
  読取り専用: true

  リンク・メンバーが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  リンク・メンバーを最後に更新したユーザー。
• LinkNumber: string
  読取り専用: true

  最大長: 255

  メンバーに関連付けられたリンクの一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MasterFlag: boolean
  最大長: 1

  リンクのマスター・メンバー。
• MemberStatus: string
  受け入れられる値のリンクmember.Theリストのステータスは、A (アクティブ)およびI (非アクティブ)です。
• PartyId: integer
  リンク・メンバーの一意の内部識別子。 リンクが関連付けられているリンク・メンバー・レコードを一意に識別するには、PartyIdまたはPartyNumberのいずれかが必要です。
• PartyName: string
  リンク・メンバーの名前。
• PartyNumber: string
  リンク・メンバーの一意のプライマリ識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the link member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the link member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the link member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "type":"string",
            "description":"The name of the link member.",
            "nullable":true,
            "x-queryable":true
        },
        "MasterFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The master member of the link.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyNumber":{
            "type":"string",
            "description":"The unique primary identifier for the link member.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique internal identifier of a link member. Either PartyId or PartyNumber is required to uniquely identify the link member record with which the link is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DepartureDate":{
            "type":"string",
            "description":"The date when the member was removed from the link.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the link associated with the member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberStatus":{
            "type":"string",
            "description":"The status of a link member.The list of accepted values are A (active) and I (inactive).",
            "nullable":true,
            "x-queryable":false
        },
        "JoinDate":{
            "type":"string",
            "description":"The date when the member joined the link.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the link member 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."
        }
    }
}

リンク

LinkMember

操作: /crmRestApi/resources/11.13.18.05/resolutionLinks/{LinkNumber}/child/LinkMember

パラメータ:

• LinkNumber: $request.path.LinkNumber

リンク・メンバー・リソースは、リンクのメンバーを表示、作成および更新するために使用されます。

「トップに戻る」