PUT v1/{Client}/Matters/{MatterId}/Attachments/{MatterAttachmentId}

Updates one Matter Attachment.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Client

The code of the Client database to connect to.

 string

Required
MatterAttachmentId

The MatterAttachmentId of the Matter Attachment.

 integer

Required
MatterId

string

None.

Body Parameters

GranicusMatterAttachment object to be updated. Note that MatterAttachmentId is not required to be set. MatterAttachmentSort cannot be changed.

GranicusMatterAttachment
NameDescriptionTypeAdditional information
MatterAttachmentId

integer

None.
MatterAttachmentGuid

string

None.
MatterAttachmentLastModifiedUtc

date

None.
MatterAttachmentRowVersion

Collection of byte

None.
MatterAttachmentName

string

Required
MatterAttachmentHyperlink

string

None.
MatterAttachmentFileName

string

None.
MatterAttachmentMatterVersion

string

None.
MatterAttachmentIsHyperlink

boolean

None.
MatterAttachmentBinary

Collection of byte

None.
MatterAttachmentIsSupportingDocument

boolean

None.
MatterAttachmentShowOnInternetPage

boolean

None.
MatterAttachmentIsMinuteOrder

boolean

None.
MatterAttachmentIsBoardLetter

boolean

None.
MatterAttachmentAgiloftId

integer

None.
MatterAttachmentDescription

string

None.
MatterAttachmentPrintWithReports

boolean

None.
MatterAttachmentSort

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "MatterAttachmentId": 1,
  "MatterAttachmentGuid": "sample string 2",
  "MatterAttachmentLastModifiedUtc": "2024-12-21T11:09:25.1383695-05:00",
  "MatterAttachmentRowVersion": "QEA=",
  "MatterAttachmentName": "sample string 4",
  "MatterAttachmentHyperlink": "sample string 5",
  "MatterAttachmentFileName": "sample string 6",
  "MatterAttachmentMatterVersion": "sample string 7",
  "MatterAttachmentIsHyperlink": true,
  "MatterAttachmentBinary": "QEA=",
  "MatterAttachmentIsSupportingDocument": true,
  "MatterAttachmentShowOnInternetPage": true,
  "MatterAttachmentIsMinuteOrder": true,
  "MatterAttachmentIsBoardLetter": true,
  "MatterAttachmentAgiloftId": 13,
  "MatterAttachmentDescription": "sample string 14",
  "MatterAttachmentPrintWithReports": true,
  "MatterAttachmentSort": 16
}

application/xml, text/xml

Sample: 
<GranicusMatterAttachment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LegistarWebAPI.Models.v1">
  <MatterAttachmentAgiloftId>13</MatterAttachmentAgiloftId>
  <MatterAttachmentBinary>QEA=</MatterAttachmentBinary>
  <MatterAttachmentDescription>sample string 14</MatterAttachmentDescription>
  <MatterAttachmentFileName>sample string 6</MatterAttachmentFileName>
  <MatterAttachmentGuid>sample string 2</MatterAttachmentGuid>
  <MatterAttachmentHyperlink>sample string 5</MatterAttachmentHyperlink>
  <MatterAttachmentId>1</MatterAttachmentId>
  <MatterAttachmentIsBoardLetter>true</MatterAttachmentIsBoardLetter>
  <MatterAttachmentIsHyperlink>true</MatterAttachmentIsHyperlink>
  <MatterAttachmentIsMinuteOrder>true</MatterAttachmentIsMinuteOrder>
  <MatterAttachmentIsSupportingDocument>true</MatterAttachmentIsSupportingDocument>
  <MatterAttachmentLastModifiedUtc>2024-12-21T11:09:25.1383695-05:00</MatterAttachmentLastModifiedUtc>
  <MatterAttachmentMatterVersion>sample string 7</MatterAttachmentMatterVersion>
  <MatterAttachmentName>sample string 4</MatterAttachmentName>
  <MatterAttachmentPrintWithReports>true</MatterAttachmentPrintWithReports>
  <MatterAttachmentRowVersion>QEA=</MatterAttachmentRowVersion>
  <MatterAttachmentShowOnInternetPage>true</MatterAttachmentShowOnInternetPage>
  <MatterAttachmentSort>16</MatterAttachmentSort>
</GranicusMatterAttachment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns Id of the updated Matter Attachment as a string value when Accept header is "text/plain"; otherwise returns updated Matter Attachment as an object.

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.