POST api/group/{id}/attachexternaldocument

Attaches the external document.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The identifier.	integer	Required

Body Parameters

The document details.

ExternalDocumentSaveDataContract

Name	Type	Additional information
Url	string	None.
StoreInRezi	boolean	None.
FileStream	Stream	None.
Tags	Collection of TagDataContract	None.
DocumentType	EnumDataContract	None.
DocumentSubType	EnumDataContract	None.
FileName	string	None.
ContentType	string	None.
FileExtension	string	None.
Description	string	None.
FileSize	string	None.
CreatedDate	date	None.
CreatedBy	CreatedByDataContract	None.
Id	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Url": "sample string 1",
  "StoreInRezi": true,
  "FileStream": null,
  "Tags": [
    {
      "Name": "sample string 1",
      "SystemStatusName": "sample string 2",
      "TagType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 3
    },
    {
      "Name": "sample string 1",
      "SystemStatusName": "sample string 2",
      "TagType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 3
    }
  ],
  "DocumentType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DocumentSubType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "FileName": "sample string 3",
  "ContentType": "sample string 4",
  "FileExtension": "sample string 5",
  "Description": "sample string 6",
  "FileSize": "sample string 7",
  "CreatedDate": "2020-07-13T17:24:00.859297Z",
  "CreatedBy": {
    "Initials": "sample string 1",
    "ContactName": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 6",
    "Id": 7
  },
  "Id": 9
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DocumentDataContract

Name	Type	Additional information
Url	string	None.
RequiresAuthentication	boolean	None.
ExpiryDate	date	None.
FileStream	Stream	None.
Tags	Collection of TagDataContract	None.
DocumentType	EnumDataContract	None.
DocumentSubType	EnumDataContract	None.
FileName	string	None.
ContentType	string	None.
FileExtension	string	None.
Description	string	None.
FileSize	string	None.
CreatedDate	date	None.
CreatedBy	CreatedByDataContract	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Url": "sample string 1",
  "RequiresAuthentication": true,
  "ExpiryDate": "2020-07-13T17:24:00.859297Z",
  "FileStream": null,
  "Tags": [
    {
      "Name": "sample string 1",
      "SystemStatusName": "sample string 2",
      "TagType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 3
    },
    {
      "Name": "sample string 1",
      "SystemStatusName": "sample string 2",
      "TagType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 3
    }
  ],
  "DocumentType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "DocumentSubType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "FileName": "sample string 3",
  "ContentType": "sample string 4",
  "FileExtension": "sample string 5",
  "Description": "sample string 6",
  "FileSize": "sample string 7",
  "CreatedDate": "2020-07-13T17:24:00.859297Z",
  "CreatedBy": {
    "Initials": "sample string 1",
    "ContactName": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 6",
    "Id": 7
  },
  "Id": 9
}