GET api/ContractFilters/{id}

Create a new empty filter instance

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Only accepts Id = 0	integer	Required

Body Parameters

None.

Response Information

Resource Description

ContractFilter

Name	Type	Additional information
SearchExpression	string	None.
DocumentName	string	None.
DocumentContent	string	None.
Name	string	None.
ContractNumber	string	None.
AccountNumber	string	None.
Note	string	None.
OrgUnitId	Collection of integer	None.
ResponsibleUserId	Collection of integer	None.
CategoryId	Collection of integer	None.
ContractTypeId	Collection of integer	None.
PartyId	Collection of integer	None.
TagId	Collection of integer	None.
StartDate	DateRange	None.
EndDate	DateRange	None.
CreateDate	DateRange	None.
LastModifiedDate	DateRange	None.
Duration	DateSpan	None.
Status	string	None.
FieldValues	Collection of EntityFieldFilterValue	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "SearchExpression": "sample string 1",
  "DocumentName": "sample string 2",
  "DocumentContent": "sample string 3",
  "Name": "sample string 4",
  "ContractNumber": "sample string 5",
  "AccountNumber": "sample string 6",
  "Note": "sample string 7",
  "OrgUnitId": [
    1,
    2
  ],
  "ResponsibleUserId": [
    1,
    2
  ],
  "CategoryId": [
    1,
    2
  ],
  "ContractTypeId": [
    1,
    2
  ],
  "PartyId": [
    1,
    2
  ],
  "TagId": [
    1,
    2
  ],
  "StartDate": {
    "From": "2025-12-08T14:24:45.4846731+00:00",
    "Until": "2025-12-08T14:24:45.4846731+00:00"
  },
  "EndDate": {
    "From": "2025-12-08T14:24:45.4846731+00:00",
    "Until": "2025-12-08T14:24:45.4846731+00:00"
  },
  "CreateDate": {
    "From": "2025-12-08T14:24:45.4846731+00:00",
    "Until": "2025-12-08T14:24:45.4846731+00:00"
  },
  "LastModifiedDate": {
    "From": "2025-12-08T14:24:45.4846731+00:00",
    "Until": "2025-12-08T14:24:45.4846731+00:00"
  },
  "Duration": {
    "Count": 1,
    "Unit": "sample string 2"
  },
  "Status": "sample string 8",
  "FieldValues": [
    {
      "FieldId": 1,
      "DateValue": {
        "From": "2025-12-08T14:24:45.4846731+00:00",
        "Until": "2025-12-08T14:24:45.4846731+00:00"
      },
      "StringValue": "sample string 2",
      "IntValue": 1,
      "FloatValue": 1.1,
      "ListValues": [
        1,
        2
      ],
      "BoolValue": true
    },
    {
      "FieldId": 1,
      "DateValue": {
        "From": "2025-12-08T14:24:45.4846731+00:00",
        "Until": "2025-12-08T14:24:45.4846731+00:00"
      },
      "StringValue": "sample string 2",
      "IntValue": 1,
      "FloatValue": 1.1,
      "ListValues": [
        1,
        2
      ],
      "BoolValue": true
    }
  ],
  "Id": 9
}

application/xml, text/xml

Sample:

<ContractFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlKeeper.ApiModel">
  <Id>9</Id>
  <AccountNumber>sample string 6</AccountNumber>
  <CategoryId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CategoryId>
  <ContractNumber>sample string 5</ContractNumber>
  <ContractTypeId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ContractTypeId>
  <CreateDate>
    <From>2025-12-08T14:24:45.4846731+00:00</From>
    <Until>2025-12-08T14:24:45.4846731+00:00</Until>
  </CreateDate>
  <DocumentContent>sample string 3</DocumentContent>
  <DocumentName>sample string 2</DocumentName>
  <Duration>
    <Count>1</Count>
    <Unit>sample string 2</Unit>
  </Duration>
  <EndDate>
    <From>2025-12-08T14:24:45.4846731+00:00</From>
    <Until>2025-12-08T14:24:45.4846731+00:00</Until>
  </EndDate>
  <FieldValues>
    <EntityFieldFilterValue>
      <BoolValue>true</BoolValue>
      <DateValue>
        <From>2025-12-08T14:24:45.4846731+00:00</From>
        <Until>2025-12-08T14:24:45.4846731+00:00</Until>
      </DateValue>
      <FieldId>1</FieldId>
      <FloatValue>1.1</FloatValue>
      <IntValue>1</IntValue>
      <ListValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ListValues>
      <StringValue>sample string 2</StringValue>
    </EntityFieldFilterValue>
    <EntityFieldFilterValue>
      <BoolValue>true</BoolValue>
      <DateValue>
        <From>2025-12-08T14:24:45.4846731+00:00</From>
        <Until>2025-12-08T14:24:45.4846731+00:00</Until>
      </DateValue>
      <FieldId>1</FieldId>
      <FloatValue>1.1</FloatValue>
      <IntValue>1</IntValue>
      <ListValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </ListValues>
      <StringValue>sample string 2</StringValue>
    </EntityFieldFilterValue>
  </FieldValues>
  <LastModifiedDate>
    <From>2025-12-08T14:24:45.4846731+00:00</From>
    <Until>2025-12-08T14:24:45.4846731+00:00</Until>
  </LastModifiedDate>
  <Name>sample string 4</Name>
  <Note>sample string 7</Note>
  <OrgUnitId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </OrgUnitId>
  <PartyId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PartyId>
  <ResponsibleUserId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ResponsibleUserId>
  <SearchExpression>sample string 1</SearchExpression>
  <StartDate>
    <From>2025-12-08T14:24:45.4846731+00:00</From>
    <Until>2025-12-08T14:24:45.4846731+00:00</Until>
  </StartDate>
  <Status>sample string 8</Status>
  <TagId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TagId>
</ContractFilter>