機械翻訳について

ジャンプ先

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

コラボレーション受信者の更新

patch

/crmRestApi/resources/11.13.18.05/collaborationRecipientLookups/{ResourceId}

リクエスト

パス・パラメータ

• ResourceId(required): integer(int64)
  コラボレーション・リソースの一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• AlternateGroupId: string
  タイトル: Collaboration Network Alternative Group ID

  最大長: 255

  リソースが属するコラボレーション・ネットワーク・チームまたはグループの代替識別子。
• CollabGroupId: string
  タイトル: Collaboration Network Group ID

  最大長: 255

  リソースが属するコラボレーション・ネットワーク・チームまたはグループの識別子。
• CollabGroupName: string
  タイトル: Collaboration Network Group Name

  最大長: 255

  リソースが属するコラボレーション・ネットワーク・チームまたはグループの名前。
• CollabId: string
  タイトル: Collaboration ID

  最大長: 255

  コラボレーション・ネットワーク内のコラボレーション・リソースの識別子。
• DisplayName: string
  タイトル: Display Name

  最大長: 400

  コラボレーション・リソースの表示名。
• Name: string
  タイトル: Resource Name

  最大長: 400

  コラボレーション・リソースの名前。
• ResourceTypeCd: string
  タイトル: Resource Type

  最大長: 30

  USER、PUBLIC_CHANNEL、PRIVATE_CHANNELなど、コラボレーション・リソースのタイプを示すコード。
• TeamId: string
  タイトル: Team ID

  最大長: 255

  リソースが属するコラボレーション・ネットワーク・ワークスペースの識別子。

{
    "type":"object",
    "properties":{
        "ResourceTypeCd":{
            "title":"Resource Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the collaboration resource such as USER, PUBLIC_CHANNEL, PRIVATE_CHANNEL.",
            "nullable":false
        },
        "CollabGroupId":{
            "title":"Collaboration Network Group ID",
            "maxLength":255,
            "type":"string",
            "description":"The identifier of the collaboration network team or group that the resource belongs to.",
            "nullable":true
        },
        "CollabGroupName":{
            "title":"Collaboration Network Group Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the collaboration network team or group that the resource belongs to.",
            "nullable":true
        },
        "CollabId":{
            "title":"Collaboration ID",
            "maxLength":255,
            "type":"string",
            "description":"The identifier of the collaboration resource in the collaboration network.",
            "nullable":false
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The display name of the collaboration resource.",
            "nullable":false
        },
        "TeamId":{
            "title":"Team ID",
            "maxLength":255,
            "type":"string",
            "description":"The identifier of the collaboration network workspace that the resource belongs to.",
            "nullable":false
        },
        "AlternateGroupId":{
            "title":"Collaboration Network Alternative Group ID",
            "maxLength":255,
            "type":"string",
            "description":"The alternative identifier of the collaboration network team or group that the resource belongs to.",
            "nullable":true
        },
        "Name":{
            "title":"Resource Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the collaboration resource.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• AlternateGroupId: string
  タイトル: Collaboration Network Alternative Group ID

  最大長: 255

  リソースが属するコラボレーション・ネットワーク・チームまたはグループの代替識別子。
• ChannelId: string
  読取り専用: true

  最大長: 255

  コラボレーション・ネットワーク・ワークスペースに関連付けられているCX Salesチャネルの識別子。
• CollabGroupId: string
  タイトル: Collaboration Network Group ID

  最大長: 255

  リソースが属するコラボレーション・ネットワーク・チームまたはグループの識別子。
• CollabGroupName: string
  タイトル: Collaboration Network Group Name

  最大長: 255

  リソースが属するコラボレーション・ネットワーク・チームまたはグループの名前。
• CollabId: string
  タイトル: Collaboration ID

  最大長: 255

  コラボレーション・ネットワーク内のコラボレーション・リソースの識別子。
• DisplayName: string
  タイトル: Display Name

  最大長: 400

  コラボレーション・リソースの表示名。
• links: array Links
  タイトル: Links

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

  最大長: 400

  コラボレーション・リソースの名前。
• ResourceId: integer (int64)
  タイトル: Resource ID

  読取り専用: true

  コラボレーション・リソースの一意の識別子。
• ResourceType: string
  読取り専用: true

  最大長: 255

  ユーザー、チャネル、プライベート・チャネルなど、コラボレーション・リソース・タイプの表示名。
• ResourceTypeCd: string
  タイトル: Resource Type

  最大長: 30

  USER、PUBLIC_CHANNEL、PRIVATE_CHANNELなど、コラボレーション・リソースのタイプを示すコード。
• TeamId: string
  タイトル: Team ID

  最大長: 255

  リソースが属するコラボレーション・ネットワーク・ワークスペースの識別子。

{
    "type":"object",
    "properties":{
        "ResourceTypeCd":{
            "title":"Resource Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the collaboration resource such as USER, PUBLIC_CHANNEL, PRIVATE_CHANNEL.",
            "nullable":false,
            "x-queryable":true
        },
        "CollabGroupId":{
            "title":"Collaboration Network Group ID",
            "maxLength":255,
            "type":"string",
            "description":"The identifier of the collaboration network team or group that the resource belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "CollabGroupName":{
            "title":"Collaboration Network Group Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the collaboration network team or group that the resource belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the collaboration resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CollabId":{
            "title":"Collaboration ID",
            "maxLength":255,
            "type":"string",
            "description":"The identifier of the collaboration resource in the collaboration network.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The display name of the collaboration resource.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceType":{
            "maxLength":255,
            "type":"string",
            "description":"The display name of the collaboration resource type such as User, Channel, Private Channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "maxLength":255,
            "type":"string",
            "description":"The identifier of the CX Sales channel that is associated with the collaboration network workspace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TeamId":{
            "title":"Team ID",
            "maxLength":255,
            "type":"string",
            "description":"The identifier of the collaboration network workspace that the resource belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "AlternateGroupId":{
            "title":"Collaboration Network Alternative Group ID",
            "maxLength":255,
            "type":"string",
            "description":"The alternative identifier of the collaboration network team or group that the resource belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Resource Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the collaboration resource.",
            "nullable":false,
            "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."
        }
    }
}

「トップに戻る」