GET api/v1/{systemName}/items/{key}

Gets an information item for a given key

Request Information

URI Parameters

Name	Description	Type	Additional information
key	Encrypted item key	string	Required

Body Parameters

None.

Response Information

Resource Description

InformationItemModel

Name	Type	Additional information
Key	string	None.
ApiId	string	None.
InformationType	SimpleInformationTypeModel	None.
InformationValues	Collection of InformationValueModel	None.
CreatedOn	date	None.
CreatedByName	string	None.
UpdatedOn	date	None.
UpdatedByName	string	None.
Locked	boolean	None.
LockedOn	date	None.
LockedByName	string	None.
IsDeleted	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Key": "sample string 1",
  "ApiId": "sample string 2",
  "InformationType": {
    "InformationGroup": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "InformationFields": [
      {
        "Id": 1,
        "InformationFieldId": 2,
        "Name": "sample string 3",
        "Type": 1,
        "Position": 4,
        "IsMandatory": true,
        "CanRead": true,
        "CanWrite": true,
        "IsRelationshipField": true,
        "RelationshipTypeId": 1,
        "DisabledFilter": 1,
        "HiddenFilter": 1,
        "SystemControlled": true
      },
      {
        "Id": 1,
        "InformationFieldId": 2,
        "Name": "sample string 3",
        "Type": 1,
        "Position": 4,
        "IsMandatory": true,
        "CanRead": true,
        "CanWrite": true,
        "IsRelationshipField": true,
        "RelationshipTypeId": 1,
        "DisabledFilter": 1,
        "HiddenFilter": 1,
        "SystemControlled": true
      }
    ],
    "Id": 1,
    "Name": "sample string 2"
  },
  "InformationValues": [
    {
      "InformationFieldId": 1,
      "Type": 2,
      "NumericValue": 1.1,
      "TextValue": "sample string 3",
      "NotesValue": "sample string 4",
      "DateTimeValue": "2025-08-28T19:50:06.4522804+01:00",
      "BooleanValue": true,
      "PlaceholderValue": "sample string 5"
    },
    {
      "InformationFieldId": 1,
      "Type": 2,
      "NumericValue": 1.1,
      "TextValue": "sample string 3",
      "NotesValue": "sample string 4",
      "DateTimeValue": "2025-08-28T19:50:06.4522804+01:00",
      "BooleanValue": true,
      "PlaceholderValue": "sample string 5"
    }
  ],
  "CreatedOn": "2025-08-28T19:50:06.4522804+01:00",
  "CreatedByName": "sample string 3",
  "UpdatedOn": "2025-08-28T19:50:06.4522804+01:00",
  "UpdatedByName": "sample string 4",
  "Locked": true,
  "LockedOn": "2025-08-28T19:50:06.4522804+01:00",
  "LockedByName": "sample string 6",
  "IsDeleted": true
}

application/xml, text/xml

Sample:

<InformationItemModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Excelpoint.Varna.Api.Models">
  <ApiId>sample string 2</ApiId>
  <CreatedByName>sample string 3</CreatedByName>
  <CreatedOn>2025-08-28T19:50:06.4522804+01:00</CreatedOn>
  <InformationType>
    <Id>1</Id>
    <InformationFields>
      <SimpleInformationFieldModel>
        <CanRead>true</CanRead>
        <CanWrite>true</CanWrite>
        <DisabledFilter>1</DisabledFilter>
        <HiddenFilter>1</HiddenFilter>
        <Id>1</Id>
        <InformationFieldId>2</InformationFieldId>
        <IsMandatory>true</IsMandatory>
        <IsRelationshipField>true</IsRelationshipField>
        <Name>sample string 3</Name>
        <Position>4</Position>
        <RelationshipTypeId>1</RelationshipTypeId>
        <SystemControlled>true</SystemControlled>
        <Type>Alphanumeric</Type>
      </SimpleInformationFieldModel>
      <SimpleInformationFieldModel>
        <CanRead>true</CanRead>
        <CanWrite>true</CanWrite>
        <DisabledFilter>1</DisabledFilter>
        <HiddenFilter>1</HiddenFilter>
        <Id>1</Id>
        <InformationFieldId>2</InformationFieldId>
        <IsMandatory>true</IsMandatory>
        <IsRelationshipField>true</IsRelationshipField>
        <Name>sample string 3</Name>
        <Position>4</Position>
        <RelationshipTypeId>1</RelationshipTypeId>
        <SystemControlled>true</SystemControlled>
        <Type>Alphanumeric</Type>
      </SimpleInformationFieldModel>
    </InformationFields>
    <InformationGroup>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </InformationGroup>
    <Name>sample string 2</Name>
  </InformationType>
  <InformationValues>
    <InformationValueModel>
      <BooleanValue>true</BooleanValue>
      <DateTimeValue>2025-08-28T19:50:06.4522804+01:00</DateTimeValue>
      <InformationFieldId>1</InformationFieldId>
      <NotesValue>sample string 4</NotesValue>
      <NumericValue>1.1</NumericValue>
      <PlaceholderValue>sample string 5</PlaceholderValue>
      <TextValue>sample string 3</TextValue>
      <Type>2</Type>
    </InformationValueModel>
    <InformationValueModel>
      <BooleanValue>true</BooleanValue>
      <DateTimeValue>2025-08-28T19:50:06.4522804+01:00</DateTimeValue>
      <InformationFieldId>1</InformationFieldId>
      <NotesValue>sample string 4</NotesValue>
      <NumericValue>1.1</NumericValue>
      <PlaceholderValue>sample string 5</PlaceholderValue>
      <TextValue>sample string 3</TextValue>
      <Type>2</Type>
    </InformationValueModel>
  </InformationValues>
  <IsDeleted>true</IsDeleted>
  <Key>sample string 1</Key>
  <Locked>true</Locked>
  <LockedByName>sample string 6</LockedByName>
  <LockedOn>2025-08-28T19:50:06.4522804+01:00</LockedOn>
  <UpdatedByName>sample string 4</UpdatedByName>
  <UpdatedOn>2025-08-28T19:50:06.4522804+01:00</UpdatedOn>
</InformationItemModel>