POST api/v2.0/ExternalActivity/Create

Create a new ExternalActivity record.

Request Information

URI Parameters

None.

Body Parameters

External Activity data.

Name	Description	Type	Additional 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.
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": "836895fb-6d56-4ce9-bb75-859cb40b561e",
  "LegacyActivityTypeKey": "sample string 2",
  "ContactKey": "0d647199-7510-4e69-bc5e-d990dcdff933",
  "LegacyContactKey": "sample string 3",
  "ActivityDateTime": "2022-12-01T15:37:59.2685752Z",
  "ActivityTitle": "sample string 5",
  "ActivityDetails": "sample string 6",
  "ActivityUrl": "sample string 7",
  "LegacyActivityKey": "sample string 8",
  "Date1": "2022-12-01T15:37:59.2685752Z",
  "Date2": "2022-12-01T15:37:59.2685752Z",
  "Date3": "2022-12-01T15:37:59.2685752Z",
  "Number1": 1.0,
  "Number2": 1.0,
  "Number3": 1.0,
  "Text1": "sample string 9",
  "Text2": "sample string 10",
  "Text3": "sample string 11",
  "SecurityGroupKeysRequiredToView": "sample string 12",
  "CommunityKeysRequiredToView": "sample string 13"
}

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>2022-12-01T10:37:59.2685752-05:00</ActivityDateTime>
  <ActivityDetails>sample string 6</ActivityDetails>
  <ActivityTitle>sample string 5</ActivityTitle>
  <ActivityUrl>sample string 7</ActivityUrl>
  <CommunityKeysRequiredToView>sample string 13</CommunityKeysRequiredToView>
  <ContactKey>0d647199-7510-4e69-bc5e-d990dcdff933</ContactKey>
  <Date1>2022-12-01T10:37:59.2685752-05:00</Date1>
  <Date2>2022-12-01T10:37:59.2685752-05:00</Date2>
  <Date3>2022-12-01T10:37:59.2685752-05:00</Date3>
  <ExternalActivityTypeKey>836895fb-6d56-4ce9-bb75-859cb40b561e</ExternalActivityTypeKey>
  <LegacyActivityKey>sample string 8</LegacyActivityKey>
  <LegacyActivityTypeKey>sample string 2</LegacyActivityTypeKey>
  <LegacyContactKey>sample string 3</LegacyContactKey>
  <Number1>1</Number1>
  <Number2>1</Number2>
  <Number3>1</Number3>
  <SecurityGroupKeysRequiredToView>sample string 12</SecurityGroupKeysRequiredToView>
  <Text1>sample string 9</Text1>
  <Text2>sample string 10</Text2>
  <Text3>sample string 11</Text3>
</ExternalActivityRequest>

Response Information

Resource Description

ExternalActivity

Name	Description	Type	Additional 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": "009289bd-1f5b-443d-aa89-bdb99228e416",
  "ExternalActivityTypeKey": "c92b8f9e-7e27-4289-8844-394ee9fa3ab3",
  "LegacyActivityTypeKey": "sample string 3",
  "ContactKey": "047aba09-b6b4-42f5-bd45-f50cf9a17d79",
  "LegacyContactKey": "sample string 4",
  "ActivityDateTime": "2022-12-01T15:37:59.2842678Z",
  "ActivityTitle": "sample string 6",
  "ActivityDetails": "sample string 7",
  "ActivityUrl": "sample string 8",
  "LegacyActivityKey": "sample string 9",
  "Date1": "2022-12-01T15:37:59.2842678Z",
  "Date2": "2022-12-01T15:37:59.2842678Z",
  "Date3": "2022-12-01T15:37:59.2842678Z",
  "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>2022-12-01T10:37:59.2842678-05:00</ActivityDateTime>
  <ActivityDetails>sample string 7</ActivityDetails>
  <ActivityTitle>sample string 6</ActivityTitle>
  <ActivityUrl>sample string 8</ActivityUrl>
  <ContactKey>047aba09-b6b4-42f5-bd45-f50cf9a17d79</ContactKey>
  <Date1>2022-12-01T10:37:59.2842678-05:00</Date1>
  <Date2>2022-12-01T10:37:59.2842678-05:00</Date2>
  <Date3>2022-12-01T10:37:59.2842678-05:00</Date3>
  <ExternalActivityKey>009289bd-1f5b-443d-aa89-bdb99228e416</ExternalActivityKey>
  <ExternalActivityTypeKey>c92b8f9e-7e27-4289-8844-394ee9fa3ab3</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>