| GET,OPTIONS | /v1/documentshare/attachment/{AttachmentId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AttachmentId | path | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| DocumentShare | form | List<DocumentShareExtended> | No | |
| ShareUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AttachmentName | form | string | No | |
| RecipientDisplayName | form | string | No | |
| RecipientType | form | string | No | |
| CreatedByName | form | string | No | |
| Status | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentShareId | form | int | No | |
| DocumentShareUID | form | Guid | No | |
| TokenHash | form | string | No | |
| AttachmentId | form | Guid | No | |
| SensitivityTier | form | string | No | |
| RequireOtp | form | bool | No | |
| OtpChannel | form | string | No | |
| DeliveryChannels | form | string | No | |
| RecipientContactId | form | int? | No | |
| RecipientEmail | form | string | No | |
| RecipientPhone | form | string | No | |
| SmsConsentSnapshot | form | bool | No | |
| CreatedByUserId | form | Guid | No | |
| CreatedByAgentId | form | int? | No | |
| CreatedAtUtc | form | DateTime | No | |
| ExpiresAtUtc | form | DateTime | No | |
| MaxViews | form | int? | No | |
| ViewCount | form | int | No | |
| RevokedAtUtc | form | DateTime? | No | |
| RevokedByUserId | form | Guid? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/documentshare/attachment/{AttachmentId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"DocumentShare":[{"AttachmentName":"String","RecipientDisplayName":"String","RecipientType":"String","CreatedByName":"String","Status":"String","DocumentShareId":0,"DocumentShareUID":"00000000000000000000000000000000","TokenHash":"String","AttachmentId":"00000000000000000000000000000000","SensitivityTier":"String","RequireOtp":false,"OtpChannel":"String","DeliveryChannels":"String","RecipientContactId":0,"RecipientEmail":"String","RecipientPhone":"String","SmsConsentSnapshot":false,"CreatedByUserId":"00000000000000000000000000000000","CreatedByAgentId":0,"CreatedAtUtc":"0001-01-01T00:00:00.0000000","ExpiresAtUtc":"0001-01-01T00:00:00.0000000","MaxViews":0,"ViewCount":0,"RevokedAtUtc":"0001-01-01T00:00:00.0000000","RevokedByUserId":"00000000000000000000000000000000"}],"ShareUrl":"String"}