GET api/Projects/GetDataSheet/{securityCode}/{storeCode}

Returns an UpProjectDataSheet JSON object with all property and asset information that matches the supplied Guid. The datasheet name limits the set of returned properties and assets to a set that is connected to this specific datasheet only (mandatory body field[s]: Guid, DataSheetName - optional body field[s]: StateApproved, StatePublished and StateReferenceDate can be supplied to influence the default handling of non published/approved or expired entities)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
securityCode

Used for authorization

 globally unique identifier

Required
storeCode

Used to specify target database

 string

Required

Body Parameters

Mandatory body field(s): Guid, DataSheetName

ApiRequestObject
NameDescriptionTypeAdditional information
Guid

globally unique identifier

None.
IgnoreCache

boolean

None.
Clean

boolean

None.
Range

integer

None.
Filter

string

None.
DataContractName

string

None.
Name

string

None.
DataSheetName

string

None.
TemplateName

string

None.
TemplateGroupName

string

None.
Variables

string

None.
SubDirectories

string

None.
Channel

string

None.
View

string

None.
Search

string

None.
Configuration

string

None.
Type

string

None.
Delimiter

string

None.
City

string

None.
Country

string

None.
Latitude

string

None.
Longitude

string

None.
PropertyTypes

string

None.
EntityTypes

string

None.
StateApproved

ExpressionFilterState

None.
StatePublished

ExpressionFilterState

None.
StateReferenceDate

ExpressionFilterState

None.

Request Formats

application/json, text/json

Sample: 
{
  "Guid": "3eeb5405-83f4-4eff-bd91-27d6be95f10f",
  "IgnoreCache": true,
  "Clean": true,
  "Range": 4,
  "Filter": "sample string 5",
  "DataContractName": "sample string 6",
  "Name": "sample string 7",
  "DataSheetName": "sample string 8",
  "TemplateName": "sample string 9",
  "TemplateGroupName": "sample string 10",
  "Variables": "sample string 11",
  "SubDirectories": "sample string 12",
  "Channel": "sample string 13",
  "View": "sample string 14",
  "Search": "sample string 15",
  "Configuration": "sample string 16",
  "Type": "sample string 17",
  "Delimiter": "sample string 18",
  "City": "sample string 19",
  "Country": "sample string 20",
  "Latitude": "sample string 21",
  "Longitude": "sample string 22",
  "PropertyTypes": "sample string 23",
  "EntityTypes": "sample string 24",
  "StateApproved": 0,
  "StatePublished": 0,
  "StateReferenceDate": 0
}

text/html, application/octet-stream

Sample: 
{"Guid":"3eeb5405-83f4-4eff-bd91-27d6be95f10f","IgnoreCache":true,"Clean":true,"Range":4,"Filter":"sample string 5","DataContractName":"sample string 6","Name":"sample string 7","DataSheetName":"sample string 8","TemplateName":"sample string 9","TemplateGroupName":"sample string 10","Variables":"sample string 11","SubDirectories":"sample string 12","Channel":"sample string 13","View":"sample string 14","Search":"sample string 15","Configuration":"sample string 16","Type":"sample string 17","Delimiter":"sample string 18","City":"sample string 19","Country":"sample string 20","Latitude":"sample string 21","Longitude":"sample string 22","PropertyTypes":"sample string 23","EntityTypes":"sample string 24","StateApproved":0,"StatePublished":0,"StateReferenceDate":0}

application/xml, text/xml

Sample: 
<ApiRequestObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Up.Engine.Service.WebAPI.Models">
  <Channel>sample string 13</Channel>
  <City>sample string 19</City>
  <Clean>true</Clean>
  <Configuration>sample string 16</Configuration>
  <Country>sample string 20</Country>
  <DataContractName>sample string 6</DataContractName>
  <DataSheetName>sample string 8</DataSheetName>
  <Delimiter>sample string 18</Delimiter>
  <EntityTypes>sample string 24</EntityTypes>
  <Filter>sample string 5</Filter>
  <Guid>3eeb5405-83f4-4eff-bd91-27d6be95f10f</Guid>
  <IgnoreCache>true</IgnoreCache>
  <Latitude>sample string 21</Latitude>
  <Longitude>sample string 22</Longitude>
  <Name>sample string 7</Name>
  <PropertyTypes>sample string 23</PropertyTypes>
  <Range>4</Range>
  <Search>sample string 15</Search>
  <StateApproved>True</StateApproved>
  <StatePublished>True</StatePublished>
  <StateReferenceDate>True</StateReferenceDate>
  <SubDirectories>sample string 12</SubDirectories>
  <TemplateGroupName>sample string 10</TemplateGroupName>
  <TemplateName>sample string 9</TemplateName>
  <Type>sample string 17</Type>
  <Variables>sample string 11</Variables>
  <View>sample string 14</View>
</ApiRequestObject>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UpProjectDataSheet

UpProjectDataSheet
NameDescriptionTypeAdditional information
Name

string

None.
Project

UpProject

None.
Properties

Collection of UpProperty

None.
Assets

Collection of UpAsset

None.

Response Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "Project": {
    "Guid": "11f888ce-1227-43c8-9a85-aff0d18291d8",
    "CallName": "sample string 2",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "ModifyDate": "2026-01-13T18:58:14.6016903+01:00"
  },
  "Properties": [
    {
      "PropertyType": {
        "Guid": "db9566bd-1df3-4d83-94fb-fbe41956ebe2",
        "DataType": "sample string 2",
        "Name": "sample string 3",
        "Unit": "sample string 4"
      },
      "BooleanValue": true,
      "DateTimeValue": "2026-01-13T18:58:14.6016903+01:00",
      "NumericValue": 1.1,
      "TextValue": "sample string 1",
      "XmlValue": "sample string 2",
      "ModifyDate": "2026-01-13T18:58:14.6016903+01:00"
    },
    {
      "PropertyType": {
        "Guid": "db9566bd-1df3-4d83-94fb-fbe41956ebe2",
        "DataType": "sample string 2",
        "Name": "sample string 3",
        "Unit": "sample string 4"
      },
      "BooleanValue": true,
      "DateTimeValue": "2026-01-13T18:58:14.6016903+01:00",
      "NumericValue": 1.1,
      "TextValue": "sample string 1",
      "XmlValue": "sample string 2",
      "ModifyDate": "2026-01-13T18:58:14.6016903+01:00"
    }
  ],
  "Assets": [
    {
      "AssetType": {
        "Guid": "75966e55-622c-4241-9777-c9d343686913",
        "Name": "sample string 2"
      },
      "XmlValue": "sample string 1",
      "ModifyDate": "2026-01-13T18:58:14.6016903+01:00"
    },
    {
      "AssetType": {
        "Guid": "75966e55-622c-4241-9777-c9d343686913",
        "Name": "sample string 2"
      },
      "XmlValue": "sample string 1",
      "ModifyDate": "2026-01-13T18:58:14.6016903+01:00"
    }
  ]
}

text/html, application/octet-stream

Sample: 
{"Name":"sample string 1","Project":{"Guid":"11f888ce-1227-43c8-9a85-aff0d18291d8","CallName":"sample string 2","Name":"sample string 3","Description":"sample string 4","ModifyDate":"2026-01-13T18:58:14.6016903+01:00"},"Properties":[{"PropertyType":{"Guid":"db9566bd-1df3-4d83-94fb-fbe41956ebe2","DataType":"sample string 2","Name":"sample string 3","Unit":"sample string 4"},"BooleanValue":true,"DateTimeValue":"2026-01-13T18:58:14.6016903+01:00","NumericValue":1.1,"TextValue":"sample string 1","XmlValue":"sample string 2","ModifyDate":"2026-01-13T18:58:14.6016903+01:00"},{"PropertyType":{"Guid":"db9566bd-1df3-4d83-94fb-fbe41956ebe2","DataType":"sample string 2","Name":"sample string 3","Unit":"sample string 4"},"BooleanValue":true,"DateTimeValue":"2026-01-13T18:58:14.6016903+01:00","NumericValue":1.1,"TextValue":"sample string 1","XmlValue":"sample string 2","ModifyDate":"2026-01-13T18:58:14.6016903+01:00"}],"Assets":[{"AssetType":{"Guid":"75966e55-622c-4241-9777-c9d343686913","Name":"sample string 2"},"XmlValue":"sample string 1","ModifyDate":"2026-01-13T18:58:14.6016903+01:00"},{"AssetType":{"Guid":"75966e55-622c-4241-9777-c9d343686913","Name":"sample string 2"},"XmlValue":"sample string 1","ModifyDate":"2026-01-13T18:58:14.6016903+01:00"}]}

application/xml, text/xml

Sample: 
<UpProjectDataSheet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Up.Engine.Service.Data.Model">
  <Assets>
    <UpAsset>
      <AssetType>
        <Guid>75966e55-622c-4241-9777-c9d343686913</Guid>
        <Name>sample string 2</Name>
      </AssetType>
      <ModifyDate>2026-01-13T18:58:14.6016903+01:00</ModifyDate>
      <XmlValue>sample string 1</XmlValue>
    </UpAsset>
    <UpAsset>
      <AssetType>
        <Guid>75966e55-622c-4241-9777-c9d343686913</Guid>
        <Name>sample string 2</Name>
      </AssetType>
      <ModifyDate>2026-01-13T18:58:14.6016903+01:00</ModifyDate>
      <XmlValue>sample string 1</XmlValue>
    </UpAsset>
  </Assets>
  <Name>sample string 1</Name>
  <Project>
    <CallName>sample string 2</CallName>
    <Description>sample string 4</Description>
    <Guid>11f888ce-1227-43c8-9a85-aff0d18291d8</Guid>
    <ModifyDate>2026-01-13T18:58:14.6016903+01:00</ModifyDate>
    <Name>sample string 3</Name>
  </Project>
  <Properties>
    <UpProperty>
      <BooleanValue>true</BooleanValue>
      <DateTimeValue>2026-01-13T18:58:14.6016903+01:00</DateTimeValue>
      <ModifyDate>2026-01-13T18:58:14.6016903+01:00</ModifyDate>
      <NumericValue>1.1</NumericValue>
      <PropertyType>
        <DataType>sample string 2</DataType>
        <Guid>db9566bd-1df3-4d83-94fb-fbe41956ebe2</Guid>
        <Name>sample string 3</Name>
        <Unit>sample string 4</Unit>
      </PropertyType>
      <TextValue>sample string 1</TextValue>
      <XmlValue>sample string 2</XmlValue>
    </UpProperty>
    <UpProperty>
      <BooleanValue>true</BooleanValue>
      <DateTimeValue>2026-01-13T18:58:14.6016903+01:00</DateTimeValue>
      <ModifyDate>2026-01-13T18:58:14.6016903+01:00</ModifyDate>
      <NumericValue>1.1</NumericValue>
      <PropertyType>
        <DataType>sample string 2</DataType>
        <Guid>db9566bd-1df3-4d83-94fb-fbe41956ebe2</Guid>
        <Name>sample string 3</Name>
        <Unit>sample string 4</Unit>
      </PropertyType>
      <TextValue>sample string 1</TextValue>
      <XmlValue>sample string 2</XmlValue>
    </UpProperty>
  </Properties>
</UpProjectDataSheet>