POST api/v2.0/ExternalActivity/Create
Create a new ExternalActivity record.
Request Information
URI Parameters
None.
Body Parameters
External Activity data.
ExternalActivityRequestName | 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. |
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
{ "ExternalActivityTypeKey": "2be2e135-fdab-498a-86a6-b3274780cd75", "LegacyActivityTypeKey": "sample string 2", "ContactKey": "fd7e1635-9f0f-479a-be1d-74a19f7a6fb8", "LegacyContactKey": "sample string 3", "EmailAddress": "sample string 4", "ActivityDateTime": "2024-09-08T00:52:36.8408955Z", "ActivityTitle": "sample string 6", "ActivityDetails": "sample string 7", "ActivityUrl": "sample string 8", "LegacyActivityKey": "sample string 9", "Date1": "2024-09-08T00:52:36.8408955Z", "Date2": "2024-09-08T00:52:36.8408955Z", "Date3": "2024-09-08T00:52:36.8408955Z", "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
<ExternalActivityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ExternalActivity"> <ActivityDateTime>2024-09-07T20:52:36.8408955-04:00</ActivityDateTime> <ActivityDetails>sample string 7</ActivityDetails> <ActivityTitle>sample string 6</ActivityTitle> <ActivityUrl>sample string 8</ActivityUrl> <CommunityKeysRequiredToView>sample string 14</CommunityKeysRequiredToView> <ContactKey>fd7e1635-9f0f-479a-be1d-74a19f7a6fb8</ContactKey> <Date1>2024-09-07T20:52:36.8408955-04:00</Date1> <Date2>2024-09-07T20:52:36.8408955-04:00</Date2> <Date3>2024-09-07T20:52:36.8408955-04:00</Date3> <EmailAddress>sample string 4</EmailAddress> <ExternalActivityTypeKey>2be2e135-fdab-498a-86a6-b3274780cd75</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
ExternalActivityName | 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
{ "ExternalActivityKey": "b29d8c53-c496-425f-8da7-6e4c057f3e63", "ExternalActivityTypeKey": "a83b92e2-bdf9-4c79-8990-e6201e6ff5eb", "LegacyActivityTypeKey": "sample string 3", "ContactKey": "785c48e7-7c04-41ee-ab14-8d048b835cdd", "LegacyContactKey": "sample string 4", "ActivityDateTime": "2024-09-08T00:52:36.8509547Z", "ActivityTitle": "sample string 6", "ActivityDetails": "sample string 7", "ActivityUrl": "sample string 8", "LegacyActivityKey": "sample string 9", "Date1": "2024-09-08T00:52:36.8509547Z", "Date2": "2024-09-08T00:52:36.8509547Z", "Date3": "2024-09-08T00:52:36.8509547Z", "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
<ExternalActivity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.ExternalActivity"> <ActivityDateTime>2024-09-07T20:52:36.8509547-04:00</ActivityDateTime> <ActivityDetails>sample string 7</ActivityDetails> <ActivityTitle>sample string 6</ActivityTitle> <ActivityUrl>sample string 8</ActivityUrl> <ContactKey>785c48e7-7c04-41ee-ab14-8d048b835cdd</ContactKey> <Date1>2024-09-07T20:52:36.8509547-04:00</Date1> <Date2>2024-09-07T20:52:36.8509547-04:00</Date2> <Date3>2024-09-07T20:52:36.8509547-04:00</Date3> <ExternalActivityKey>b29d8c53-c496-425f-8da7-6e4c057f3e63</ExternalActivityKey> <ExternalActivityTypeKey>a83b92e2-bdf9-4c79-8990-e6201e6ff5eb</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>