POST api/v2.0/ExternalActivity/Create

Create a new ExternalActivity record.

Request Information

URI Parameters

None.

Body Parameters

External Activity data.

ExternalActivityRequest
NameDescriptionTypeAdditional information
ExternalActivityTypeKey

Optional. Uniqueidentifier. Our key to the type. Required unless LegacyActivityTypeKey is supplied.

 globally unique identifier

None.
LegacyActivityTypeKey

Optional. Nvarchar(100). The caller’s key to the type. Required unless ActivityTypeKey is supplied. If supplied, used to lookup ActivityTypeKey in ActivityTypeRef.

 string

None.
ContactKey

Optional. Uniqueidentifier. Our key to the contact affected. Required unless LegacyContactKey is supplied.

 globally unique identifier

None.
LegacyContactKey

Optional. Nvarchar(100). The caller’s key to the contact affected. Required unless ContactKey is supplied. If supplied, used to lookup ContactKey in Contact.

 string

None.
EmailAddress

Optional. Nvarchar(100). The caller’s key to the contact affected. Required unless ContactKey or LegacyContactKey is supplied. If supplied, used to lookup ContactKey in Contact.

 string

None.
ActivityDateTime

Required. Datetime. The date and time the activity occurred.

 date

None.
ActivityTitle

Required. nvarchar(500). The title of the activity.

 string

None.
ActivityDetails

Optional. nvarchar(max). Any details the caller wants to include to describe the activity.

 string

None.
ActivityUrl

Optional. nvarchar(500). An absolute URL linking to the caller’s view of the activity

 string

None.
LegacyActivityKey

Optional. nvarchar(100).The caller’s key to the activity. Used for future updates and deletes.

 string

None.
Date1

Optional. Datetime. A date and time that is associated with the activity and defined by the type.

 date

None.
Date2

Optional. Datetime. A date and time that is associated with the activity and defined by the type.

 date

None.
Date3

Optional. Datetime. A date and time that is associated with the activity and defined by the type.

 date

None.
Number1

Optional. decimal(12,2). A numeric value that is associated with the activity and defined by the type.

 decimal number

None.
Number2

Optional. decimal(12,2). A numeric value that is associated with the activity and defined by the type.

 decimal number

None.
Number3

Optional. decimal(12,2). A numeric value that is associated with the activity and defined by the type.

 decimal number

None.
Text1

Optional. nvarchar(max). A string value that is associated with the activity and defined by the type.

 string

None.
Text2

Optional. nvarchar(max). A string value that is associated with the activity and defined by the type.

 string

None.
Text3

Optional. nvarchar(max). A string value that is associated with the activity and defined by the type.

 string

None.
SecurityGroupKeysRequiredToView

Optional. Default Public. nvarchar(max). A comma separated list of SecurityGroupKeys (Guid)

 string

None.
CommunityKeysRequiredToView

Optional. nvarchar(max). A comma separated list of CommunityKeys (Guid)

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ExternalActivityTypeKey": "b2490d23-bb37-49ad-963d-72e4487fc0f9",
  "LegacyActivityTypeKey": "sample string 2",
  "ContactKey": "9e22a231-bf86-4a2e-97bc-183685edbe17",
  "LegacyContactKey": "sample string 3",
  "EmailAddress": "sample string 4",
  "ActivityDateTime": "2024-12-21T16:36:42.241262Z",
  "ActivityTitle": "sample string 6",
  "ActivityDetails": "sample string 7",
  "ActivityUrl": "sample string 8",
  "LegacyActivityKey": "sample string 9",
  "Date1": "2024-12-21T16:36:42.241262Z",
  "Date2": "2024-12-21T16:36:42.241262Z",
  "Date3": "2024-12-21T16:36:42.241262Z",
  "Number1": 1.0,
  "Number2": 1.0,
  "Number3": 1.0,
  "Text1": "sample string 10",
  "Text2": "sample string 11",
  "Text3": "sample string 12",
  "SecurityGroupKeysRequiredToView": "sample string 13",
  "CommunityKeysRequiredToView": "sample string 14"
}

application/xml, text/xml

Sample: 
<ExternalActivityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ExternalActivity">
  <ActivityDateTime>2024-12-21T11:36:42.241262-05:00</ActivityDateTime>
  <ActivityDetails>sample string 7</ActivityDetails>
  <ActivityTitle>sample string 6</ActivityTitle>
  <ActivityUrl>sample string 8</ActivityUrl>
  <CommunityKeysRequiredToView>sample string 14</CommunityKeysRequiredToView>
  <ContactKey>9e22a231-bf86-4a2e-97bc-183685edbe17</ContactKey>
  <Date1>2024-12-21T11:36:42.241262-05:00</Date1>
  <Date2>2024-12-21T11:36:42.241262-05:00</Date2>
  <Date3>2024-12-21T11:36:42.241262-05:00</Date3>
  <EmailAddress>sample string 4</EmailAddress>
  <ExternalActivityTypeKey>b2490d23-bb37-49ad-963d-72e4487fc0f9</ExternalActivityTypeKey>
  <LegacyActivityKey>sample string 9</LegacyActivityKey>
  <LegacyActivityTypeKey>sample string 2</LegacyActivityTypeKey>
  <LegacyContactKey>sample string 3</LegacyContactKey>
  <Number1>1</Number1>
  <Number2>1</Number2>
  <Number3>1</Number3>
  <SecurityGroupKeysRequiredToView>sample string 13</SecurityGroupKeysRequiredToView>
  <Text1>sample string 10</Text1>
  <Text2>sample string 11</Text2>
  <Text3>sample string 12</Text3>
</ExternalActivityRequest>

Response Information

Resource Description

ExternalActivity
NameDescriptionTypeAdditional information
ExternalActivityKey

The UniqueIdentifier for the External Activity Record.

 globally unique identifier

None.
ExternalActivityTypeKey

Optional. Uniqueidentifier. Our key to the type. Required unless LegacyActivityTypeKey is supplied.

 globally unique identifier

None.
LegacyActivityTypeKey

Optional. Nvarchar(100). The caller’s key to the type. Required unless ActivityTypeKey is supplied. If supplied, used to lookup ActivityTypeKey in ActivityTypeRef.

 string

None.
ContactKey

Optional. Uniqueidentifier. Our key to the contact affected. Required unless LegacyContactKey is supplied.

 globally unique identifier

None.
LegacyContactKey

Optional. Nvarchar(100). The caller’s key to the contact affected. Required unless ContactKey is supplied. If supplied, used to lookup ContactKey in Contact.

 string

None.
ActivityDateTime

Required. Datetime. The date and time the activity occurred.

 date

None.
ActivityTitle

Required. nvarchar(500). The title of the activity.

 string

None.
ActivityDetails

Optional. nvarchar(max). Any details the caller wants to include to describe the activity.

 string

None.
ActivityUrl

Optional. nvarchar(500). An absolute URL linking to the caller’s view of the activity

 string

None.
LegacyActivityKey

Optional. nvarchar(100).The caller’s key to the activity. Used for future updates and deletes.

 string

None.
Date1

Optional. Datetime. A date and time that is associated with the activity and defined by the type.

 date

None.
Date2

Optional. Datetime. A date and time that is associated with the activity and defined by the type.

 date

None.
Date3

Optional. Datetime. A date and time that is associated with the activity and defined by the type.

 date

None.
Number1

Optional. decimal(12,2). A numeric value that is associated with the activity and defined by the type.

 decimal number

None.
Number2

Optional. decimal(12,2). A numeric value that is associated with the activity and defined by the type.

 decimal number

None.
Number3

Optional. decimal(12,2). A numeric value that is associated with the activity and defined by the type.

 decimal number

None.
Text1

Optional. nvarchar(max). A string value that is associated with the activity and defined by the type.

 string

None.
Text2

Optional. nvarchar(max). A string value that is associated with the activity and defined by the type.

 string

None.
Text3

Optional. nvarchar(max). A string value that is associated with the activity and defined by the type.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ExternalActivityKey": "973b69d3-3c48-406d-a904-3cfe588f376c",
  "ExternalActivityTypeKey": "a94c929c-98e8-43cb-9060-7e1aba3a245d",
  "LegacyActivityTypeKey": "sample string 3",
  "ContactKey": "b2396ba3-81a4-4c1e-b020-5d2eb87b1567",
  "LegacyContactKey": "sample string 4",
  "ActivityDateTime": "2024-12-21T16:36:42.2513041Z",
  "ActivityTitle": "sample string 6",
  "ActivityDetails": "sample string 7",
  "ActivityUrl": "sample string 8",
  "LegacyActivityKey": "sample string 9",
  "Date1": "2024-12-21T16:36:42.2513041Z",
  "Date2": "2024-12-21T16:36:42.2513041Z",
  "Date3": "2024-12-21T16:36:42.2513041Z",
  "Number1": 1.0,
  "Number2": 1.0,
  "Number3": 1.0,
  "Text1": "sample string 10",
  "Text2": "sample string 11",
  "Text3": "sample string 12"
}

application/xml, text/xml

Sample: 
<ExternalActivity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ExternalActivity">
  <ActivityDateTime>2024-12-21T11:36:42.2513041-05:00</ActivityDateTime>
  <ActivityDetails>sample string 7</ActivityDetails>
  <ActivityTitle>sample string 6</ActivityTitle>
  <ActivityUrl>sample string 8</ActivityUrl>
  <ContactKey>b2396ba3-81a4-4c1e-b020-5d2eb87b1567</ContactKey>
  <Date1>2024-12-21T11:36:42.2513041-05:00</Date1>
  <Date2>2024-12-21T11:36:42.2513041-05:00</Date2>
  <Date3>2024-12-21T11:36:42.2513041-05:00</Date3>
  <ExternalActivityKey>973b69d3-3c48-406d-a904-3cfe588f376c</ExternalActivityKey>
  <ExternalActivityTypeKey>a94c929c-98e8-43cb-9060-7e1aba3a245d</ExternalActivityTypeKey>
  <LegacyActivityKey>sample string 9</LegacyActivityKey>
  <LegacyActivityTypeKey>sample string 3</LegacyActivityTypeKey>
  <LegacyContactKey>sample string 4</LegacyContactKey>
  <Number1>1</Number1>
  <Number2>1</Number2>
  <Number3>1</Number3>
  <Text1>sample string 10</Text1>
  <Text2>sample string 11</Text2>
  <Text3>sample string 12</Text3>
</ExternalActivity>