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

機械翻訳について

Microsoft Teamsでのコラボレーションの作成

post

/crmRestApi/resources/11.13.18.05/collaborations

リクエスト

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

Description: string

最大長: 1024

コラボレーション・ツールに表示されるコラボレーションの説明。たとえば、Microsoft Teamsに示されているチームの説明などです。
Name: string

最大長: 128

コラボレーション・ツールに表示されるコラボレーションの名前。たとえば、Microsoft Teamsに示されているチーム名などです。
ObjectId: string

最大長: 64

商談IDなど、コラボレーションが関連付けられているレコードの一意の識別子。
ObjectName: string

最大長: 128

商談など、コラボレーションが関連付けられているレコードのオブジェクト・タイプの残りのリソース名。
TeamRelationshipName: string

最大長: 80

リソース・チーム・オブジェクトとコラボレーションが関連付けられているオブジェクト・タイプ間の関係の名前。これは、オブジェクト・タイプがカスタム・オブジェクトの場合に使用されます。

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":1024,
            "type":"string",
            "description":"The description of the collaboration displayed in the collaboration tool, for example, the description of the team shown in Microsoft Teams.",
            "nullable":true
        },
        "TeamRelationshipName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the relationship between Resource team object and the object type that the collaboration is associated to. This is used when object type is a custom object.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectId":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the record that the collaboration is associated to such as the opportunity ID.",
            "nullable":true
        },
        "ObjectName":{
            "maxLength":128,
            "type":"string",
            "description":"The rest resource name of the object type of the record that the collaboration is associated to such as opportunities.",
            "nullable":true
        },
        "Name":{
            "maxLength":128,
            "type":"string",
            "description":"The name of the collaboration displayed in the collaboration tool, for example, the team name shown in Microsoft Teams.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

CollabId: string

読取り専用: true

最大長: 64

コラボレーションの一意の識別子。
CreatedBy: string

読取り専用: true

最大長: 64

コラボレーションを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

コラボレーションが作成された日付。
Description: string

最大長: 1024

コラボレーション・ツールに表示されるコラボレーションの説明。たとえば、Microsoft Teamsに示されているチームの説明などです。
LastUpdateDate: string (date-time)

読取り専用: true

コラボレーションが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

コラボレーションを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

コラボレーションを最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

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

最大長: 128

コラボレーション・ツールに表示されるコラボレーションの名前。たとえば、Microsoft Teamsに示されているチーム名などです。
ObjectId: string

最大長: 64

商談IDなど、コラボレーションが関連付けられているレコードの一意の識別子。
ObjectName: string

最大長: 128

商談など、コラボレーションが関連付けられているレコードのオブジェクト・タイプの残りのリソース名。
TeamRelationshipName: string

最大長: 80

リソース・チーム・オブジェクトとコラボレーションが関連付けられているオブジェクト・タイプ間の関係の名前。これは、オブジェクト・タイプがカスタム・オブジェクトの場合に使用されます。
Weburl: string

読取り専用: true

最大長: 512

コラボレーション・ツールのコラボレーションへの外部URL。たとえば、Microsoft TeamsのTeamへのURLです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the collaboration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the collaboration was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the collaboration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":1024,
            "type":"string",
            "description":"The description of the collaboration displayed in the collaboration tool, for example, the description of the team shown in Microsoft Teams.",
            "nullable":true,
            "x-queryable":true
        },
        "TeamRelationshipName":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the relationship between Resource team object and the object type that the collaboration is associated to. This is used when object type is a custom object.",
            "nullable":true,
            "x-queryable":false
        },
        "CollabId":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the collaboration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the record that the collaboration is associated to such as the opportunity ID.",
            "nullable":true,
            "x-queryable":true
        },
        "Weburl":{
            "maxLength":512,
            "type":"string",
            "description":"The external URL to the collaboration in the collaboration tool, for example, the URL to Team in Microsoft Teams.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectName":{
            "maxLength":128,
            "type":"string",
            "description":"The rest resource name of the object type of the record that the collaboration is associated to such as opportunities.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":128,
            "type":"string",
            "description":"The name of the collaboration displayed in the collaboration tool, for example, the team name shown in Microsoft Teams.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the collaboration was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the collaboration.",
            "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."
        }
    }
}

トップに戻る

例:

次の例は、RESTリソースに対してPOSTリクエストを発行して、microsoftチームでのコラボレーションを作成する方法を示しています。

cURLコマンド

curl -u <username:password> \
 -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborations/  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
    "Name": "AccountTestingDes1",
    "Description" : "abcd232",
    "ObjectId": "300100567612000",
    "ObjectName": "accounts",
    "TeamRelationshipName":"SalesResourceMM"
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "CollabId": "300100568007996",
    "CreatedBy": "SALES_ADMIN",
    "CreationDate": "2022-12-14T10:01:02.080+00:00",
    "LastUpdateDate": "2022-12-14T10:01:02.080+00:00",
    "LastUpdateLogin": null,
    "LastUpdatedBy": "SALES_ADMIN",
    "Weburl": "https://teams.microsoft.com/l/team/19%3axn2II-yyBI7mv5OmAxEmJMa4irl1O-3rIVuC6Jd0IB81%40thread.tacv2/conversations?groupId=e19c3974-bddd-4d69-9120-6abde9da4495&tenantId=33b71f2d-7f52-4370-bd2c-08efb530b1c3",
    "ObjectId": "300100567612000",
    "ObjectName": "accounts",
    "Name": "Accounts - AccountTestingDes1",
    "Description": "This team is specifically for the AccountTestingDes1 account: abcd232",
    "TeamRelationshipName": "SalesResourceMM",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborations/300100568007996",
            "name": "collaborations",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborations/300100568007996",
            "name": "collaborations",
            "kind": "item"
        }
    ]
}

「トップに戻る」