REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Create a Collaboration in Microsoft Teams

post

/crmRestApi/resources/11.13.18.05/collaborations

Request

Header Parameters

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

Description: string

Maximum Length: 1024

The description of the collaboration displayed in the collaboration tool, for example, the description of the team shown in Microsoft Teams.
Name: string

Maximum Length: 128

The name of the collaboration displayed in the collaboration tool, for example, the team name shown in Microsoft Teams.
ObjectId: string

Maximum Length: 64

The unique identifier of the record that the collaboration is associated to such as the opportunity ID.
ObjectName: string

Maximum Length: 128

The rest resource name of the object type of the record that the collaboration is associated to such as opportunities.
TeamRelationshipName: string

Maximum Length: 80

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.

{
    "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
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : collaborations-item-response

Type: object

Show Source

CollabId: string

Read Only: true

Maximum Length: 64

The unique identifier of the collaboration.
CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the collaboration.
CreationDate: string (date-time)

Read Only: true

The date when the collaboration was created.
Description: string

Maximum Length: 1024

The description of the collaboration displayed in the collaboration tool, for example, the description of the team shown in Microsoft Teams.
LastUpdateDate: string (date-time)

Read Only: true

The date when the collaboration was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the collaboration.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

The login details of the user who last updated the collaboration.
links: array Links

Title: Links

The link relations associated with the resource instance.
Name: string

Maximum Length: 128

The name of the collaboration displayed in the collaboration tool, for example, the team name shown in Microsoft Teams.
ObjectId: string

Maximum Length: 64

The unique identifier of the record that the collaboration is associated to such as the opportunity ID.
ObjectName: string

Maximum Length: 128

The rest resource name of the object type of the record that the collaboration is associated to such as opportunities.
TeamRelationshipName: string

Maximum Length: 80

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.
Weburl: string

Read Only: true

Maximum Length: 512

The external URL to the collaboration in the collaboration tool, for example, the URL to Team in Microsoft Teams.

{
    "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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Examples

The following example shows how to create a collaboration in microsoft team by submitting a POST request on the REST resource.

cURL Command

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

Example of Request Body

The following example shows the contents of the request body in JSON format.

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

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "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"
        }
    ]
}