POST v1/{Client}/Matters/{MatterId}/Indexes

Adds one Matter Index.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Client

The code of the Client database to connect to.

 string

Required
MatterId

string

None.

Body Parameters

GranicusMatterIndex object to be inserted. Note that MatterIndexId is not required to be set.

GranicusMatterIndex
NameDescriptionTypeAdditional information
MatterIndexId

integer

None.
MatterIndexGuid

string

None.
MatterIndexLastModifiedUtc

date

None.
MatterIndexRowVersion

Collection of byte

None.
MatterIndexMatterId

integer

Required
MatterIndexIndexId

integer

Required
MatterIndexName

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "MatterIndexId": 1,
  "MatterIndexGuid": "sample string 2",
  "MatterIndexLastModifiedUtc": "2024-11-21T05:26:27.6942241-05:00",
  "MatterIndexRowVersion": "QEA=",
  "MatterIndexMatterId": 4,
  "MatterIndexIndexId": 5,
  "MatterIndexName": "sample string 6"
}

application/xml, text/xml

Sample: 
<GranicusMatterIndex xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LegistarWebAPI.Models.v1">
  <MatterIndexGuid>sample string 2</MatterIndexGuid>
  <MatterIndexId>1</MatterIndexId>
  <MatterIndexIndexId>5</MatterIndexIndexId>
  <MatterIndexLastModifiedUtc>2024-11-21T05:26:27.6942241-05:00</MatterIndexLastModifiedUtc>
  <MatterIndexMatterId>4</MatterIndexMatterId>
  <MatterIndexName>sample string 6</MatterIndexName>
  <MatterIndexRowVersion>QEA=</MatterIndexRowVersion>
</GranicusMatterIndex>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns Id of a created Matter Index as a string value when Accept header is "text/plain"; otherwise returns created Matter Index 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.