MyCSI API - Documentation

GET Assets/{id}

Method used to fetch a collection of Assets.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Security token provided via the Authentication method.

 globally unique identifier

Required

Body Parameters

Objects used to page through the collection of Assets, as well as filter the returned objects.

AssetFilterModel
NameDescriptionTypeAdditional information
AssetID

Optional, the internal CSI Identifier of the Asset

 integer

None.
LastUpdated

Optional, filter Assets based on the last time they were updated. For example, if '2017-01-01' was used, all of the assets modified on and since the first of January 2017 would be returned.

 date

None.
Lease

Optional, the Lease to which the Assets belong.

 string

None.
NonManaged

Optional, filter Assets bases on whether it is a CSI Managed asset or not. Dependent on Permissions.

 NonManaged

None.
PageNumber

Optional, the number of the current 'page' of items returned during the API request.

 integer

None.
PageSize

Optional, number of items in the 'page' returned during the API request.

 integer

None.
Schedule

Optional, the Schedule to which the Assets belong.

 string

None.
ScheduleID

Optional, the internal CSI Identifier of the Schedule the asset is on.

 integer

None.
Serial

Optional, filter Assets based on the Serial Number. For example, if '1e' is used all of the assets with Serial Numbers containing '1e' will be returned.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "AssetID": 1,
  "Lease": "sample string 2",
  "ScheduleID": 3,
  "Schedule": "sample string 4",
  "Serial": "sample string 5",
  "LastUpdated": "2025-05-03T10:32:23.8102014-05:00",
  "NonManaged": 1,
  "PageNumber": 1,
  "PageSize": 1
}

application/octet-stream

Sample: 
{"AssetID":1,"Lease":"sample string 2","ScheduleID":3,"Schedule":"sample string 4","Serial":"sample string 5","LastUpdated":"2025-05-03T10:32:23.8102014-05:00","NonManaged":1,"PageNumber":1,"PageSize":1}

application/xml, text/xml

Sample: 
<AssetFilterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Filters">
  <PageNumber>1</PageNumber>
  <PageSize>1</PageSize>
  <AssetID>1</AssetID>
  <LastUpdated>2025-05-03T10:32:23.8102014-05:00</LastUpdated>
  <Lease>sample string 2</Lease>
  <NonManaged>All</NonManaged>
  <Schedule>sample string 4</Schedule>
  <ScheduleID>3</ScheduleID>
  <Serial>sample string 5</Serial>
</AssetFilterModel>

application/x-www-form-urlencoded

Sample: 
?AssetID=1&Lease=SampleString1&ScheduleID=1&Schedule=SampleString2&Serial=SampleString3&LastUpdated=2025-05-03&NonManaged=unknown&PageNumber=1&PageSize=1

Response Information

Resource Description

The AssetModel object, containing the collection of Assets.

AssetModel
NameDescriptionTypeAdditional information
Assets

Collection of Assets being returned.

 Collection of Asset

None.
ErrorMessage

Optional error message provided by the method call.

 string

None.
Message

Optional message provided by the method call.

 string

None.
Paging

Contains information relevant to paging through a collection of objects.

 PagingModel

None.
StatusCode

The HTTP Status Code of the method call.

 HttpStatusCode

None.
Success

Boolean flag indicating the success or failure of the method call.

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Message": "sample string 1",
  "StatusCode": 100,
  "Success": true,
  "Assets": [
    {
      "ID": 1,
      "Lease": "sample string 2",
      "ScheduleID": 3,
      "Schedule": "sample string 4",
      "Serial": "sample string 5",
      "Manufacturer": "sample string 6",
      "Model": "sample string 7",
      "TermStartDate": "2025-05-03T10:32:23.8414505-05:00",
      "TermEndDate": "2025-05-03T10:32:23.8414505-05:00",
      "LessorCountry": "sample string 8",
      "LessorCountryCode": "sample string 9",
      "Lessee": "sample string 10",
      "Vendor": "sample string 11",
      "CustomerReference": "sample string 12",
      "CDF01": "sample string 13",
      "CDF02": "sample string 14",
      "CDF03": "sample string 15",
      "CDF04": "sample string 16",
      "CDF05": "sample string 17",
      "CDF06": "sample string 18",
      "CDF07": "sample string 19",
      "CDF08": "sample string 20",
      "CDF09": "sample string 21",
      "CDF10": "sample string 22",
      "Currency": "sample string 23",
      "Rent": 1.0,
      "Tax": 1.0,
      "AssetInfo": "sample string 24",
      "SiteAddress": "sample string 25",
      "SiteCity": "sample string 26",
      "SiteState": "sample string 27",
      "SiteLocale": "sample string 28",
      "SiteRegion": "sample string 29",
      "SitePostalCode": "sample string 30",
      "SiteCountry": "sample string 31",
      "BillingAddress": "sample string 32",
      "BillingCity": "sample string 33",
      "BillingState": "sample string 34",
      "BillingRegion": "sample string 35",
      "BillingPostalCode": "sample string 36",
      "BillingCountry": "sample string 37",
      "InventoryId": 1,
      "NonLeased": true,
      "CMDB_ID": "sample string 39",
      "Returned": "sample string 40",
      "LastModified": "2025-05-03T10:32:23.8414505-05:00",
      "DateAccepted": "2025-05-03T10:32:23.8414505-05:00",
      "PaymentFrequency": "sample string 41",
      "PaymentCode": "sample string 42"
    },
    {
      "ID": 1,
      "Lease": "sample string 2",
      "ScheduleID": 3,
      "Schedule": "sample string 4",
      "Serial": "sample string 5",
      "Manufacturer": "sample string 6",
      "Model": "sample string 7",
      "TermStartDate": "2025-05-03T10:32:23.8414505-05:00",
      "TermEndDate": "2025-05-03T10:32:23.8414505-05:00",
      "LessorCountry": "sample string 8",
      "LessorCountryCode": "sample string 9",
      "Lessee": "sample string 10",
      "Vendor": "sample string 11",
      "CustomerReference": "sample string 12",
      "CDF01": "sample string 13",
      "CDF02": "sample string 14",
      "CDF03": "sample string 15",
      "CDF04": "sample string 16",
      "CDF05": "sample string 17",
      "CDF06": "sample string 18",
      "CDF07": "sample string 19",
      "CDF08": "sample string 20",
      "CDF09": "sample string 21",
      "CDF10": "sample string 22",
      "Currency": "sample string 23",
      "Rent": 1.0,
      "Tax": 1.0,
      "AssetInfo": "sample string 24",
      "SiteAddress": "sample string 25",
      "SiteCity": "sample string 26",
      "SiteState": "sample string 27",
      "SiteLocale": "sample string 28",
      "SiteRegion": "sample string 29",
      "SitePostalCode": "sample string 30",
      "SiteCountry": "sample string 31",
      "BillingAddress": "sample string 32",
      "BillingCity": "sample string 33",
      "BillingState": "sample string 34",
      "BillingRegion": "sample string 35",
      "BillingPostalCode": "sample string 36",
      "BillingCountry": "sample string 37",
      "InventoryId": 1,
      "NonLeased": true,
      "CMDB_ID": "sample string 39",
      "Returned": "sample string 40",
      "LastModified": "2025-05-03T10:32:23.8414505-05:00",
      "DateAccepted": "2025-05-03T10:32:23.8414505-05:00",
      "PaymentFrequency": "sample string 41",
      "PaymentCode": "sample string 42"
    }
  ],
  "Paging": {
    "PageSize": 1,
    "PageNumber": 2,
    "TotalPages": 3,
    "TotalItems": 4
  },
  "ErrorMessage": "sample string 3"
}

application/octet-stream

Sample: 
{"Message":"sample string 1","StatusCode":100,"Success":true,"Assets":[{"ID":1,"Lease":"sample string 2","ScheduleID":3,"Schedule":"sample string 4","Serial":"sample string 5","Manufacturer":"sample string 6","Model":"sample string 7","TermStartDate":"2025-05-03T10:32:23.8414505-05:00","TermEndDate":"2025-05-03T10:32:23.8414505-05:00","LessorCountry":"sample string 8","LessorCountryCode":"sample string 9","Lessee":"sample string 10","Vendor":"sample string 11","CustomerReference":"sample string 12","CDF01":"sample string 13","CDF02":"sample string 14","CDF03":"sample string 15","CDF04":"sample string 16","CDF05":"sample string 17","CDF06":"sample string 18","CDF07":"sample string 19","CDF08":"sample string 20","CDF09":"sample string 21","CDF10":"sample string 22","Currency":"sample string 23","Rent":1.0,"Tax":1.0,"AssetInfo":"sample string 24","SiteAddress":"sample string 25","SiteCity":"sample string 26","SiteState":"sample string 27","SiteLocale":"sample string 28","SiteRegion":"sample string 29","SitePostalCode":"sample string 30","SiteCountry":"sample string 31","BillingAddress":"sample string 32","BillingCity":"sample string 33","BillingState":"sample string 34","BillingRegion":"sample string 35","BillingPostalCode":"sample string 36","BillingCountry":"sample string 37","InventoryId":1,"NonLeased":true,"CMDB_ID":"sample string 39","Returned":"sample string 40","LastModified":"2025-05-03T10:32:23.8414505-05:00","DateAccepted":"2025-05-03T10:32:23.8414505-05:00","PaymentFrequency":"sample string 41","PaymentCode":"sample string 42"},{"ID":1,"Lease":"sample string 2","ScheduleID":3,"Schedule":"sample string 4","Serial":"sample string 5","Manufacturer":"sample string 6","Model":"sample string 7","TermStartDate":"2025-05-03T10:32:23.8414505-05:00","TermEndDate":"2025-05-03T10:32:23.8414505-05:00","LessorCountry":"sample string 8","LessorCountryCode":"sample string 9","Lessee":"sample string 10","Vendor":"sample string 11","CustomerReference":"sample string 12","CDF01":"sample string 13","CDF02":"sample string 14","CDF03":"sample string 15","CDF04":"sample string 16","CDF05":"sample string 17","CDF06":"sample string 18","CDF07":"sample string 19","CDF08":"sample string 20","CDF09":"sample string 21","CDF10":"sample string 22","Currency":"sample string 23","Rent":1.0,"Tax":1.0,"AssetInfo":"sample string 24","SiteAddress":"sample string 25","SiteCity":"sample string 26","SiteState":"sample string 27","SiteLocale":"sample string 28","SiteRegion":"sample string 29","SitePostalCode":"sample string 30","SiteCountry":"sample string 31","BillingAddress":"sample string 32","BillingCity":"sample string 33","BillingState":"sample string 34","BillingRegion":"sample string 35","BillingPostalCode":"sample string 36","BillingCountry":"sample string 37","InventoryId":1,"NonLeased":true,"CMDB_ID":"sample string 39","Returned":"sample string 40","LastModified":"2025-05-03T10:32:23.8414505-05:00","DateAccepted":"2025-05-03T10:32:23.8414505-05:00","PaymentFrequency":"sample string 41","PaymentCode":"sample string 42"}],"Paging":{"PageSize":1,"PageNumber":2,"TotalPages":3,"TotalItems":4},"ErrorMessage":"sample string 3"}

application/xml, text/xml

Sample: 
<AssetModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">sample string 3</ErrorMessage>
  <Message xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">sample string 1</Message>
  <StatusCode xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">Continue</StatusCode>
  <Success xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">true</Success>
  <Paging xmlns="http://schemas.datacontract.org/2004/07/CSI.MyCSI.WebAPI.Models.Shared">
    <PageNumber>2</PageNumber>
    <PageSize>1</PageSize>
    <TotalItems>4</TotalItems>
    <TotalPages>3</TotalPages>
  </Paging>
  <Assets>
    <Asset>
      <AssetInfo>sample string 24</AssetInfo>
      <BillingAddress>sample string 32</BillingAddress>
      <BillingCity>sample string 33</BillingCity>
      <BillingCountry>sample string 37</BillingCountry>
      <BillingPostalCode>sample string 36</BillingPostalCode>
      <BillingRegion>sample string 35</BillingRegion>
      <BillingState>sample string 34</BillingState>
      <CDF01>sample string 13</CDF01>
      <CDF02>sample string 14</CDF02>
      <CDF03>sample string 15</CDF03>
      <CDF04>sample string 16</CDF04>
      <CDF05>sample string 17</CDF05>
      <CDF06>sample string 18</CDF06>
      <CDF07>sample string 19</CDF07>
      <CDF08>sample string 20</CDF08>
      <CDF09>sample string 21</CDF09>
      <CDF10>sample string 22</CDF10>
      <CMDB_ID>sample string 39</CMDB_ID>
      <Currency>sample string 23</Currency>
      <CustomerReference>sample string 12</CustomerReference>
      <DateAccepted>2025-05-03T10:32:23.8414505-05:00</DateAccepted>
      <ID>1</ID>
      <InventoryId>1</InventoryId>
      <LastModified>2025-05-03T10:32:23.8414505-05:00</LastModified>
      <Lease>sample string 2</Lease>
      <Lessee>sample string 10</Lessee>
      <LessorCountry>sample string 8</LessorCountry>
      <LessorCountryCode>sample string 9</LessorCountryCode>
      <Manufacturer>sample string 6</Manufacturer>
      <Model>sample string 7</Model>
      <NonLeased>true</NonLeased>
      <PaymentCode>sample string 42</PaymentCode>
      <PaymentFrequency>sample string 41</PaymentFrequency>
      <Rent>1</Rent>
      <Returned>sample string 40</Returned>
      <Schedule>sample string 4</Schedule>
      <ScheduleID>3</ScheduleID>
      <Serial>sample string 5</Serial>
      <SiteAddress>sample string 25</SiteAddress>
      <SiteCity>sample string 26</SiteCity>
      <SiteCountry>sample string 31</SiteCountry>
      <SiteLocale>sample string 28</SiteLocale>
      <SitePostalCode>sample string 30</SitePostalCode>
      <SiteRegion>sample string 29</SiteRegion>
      <SiteState>sample string 27</SiteState>
      <Tax>1</Tax>
      <TermEndDate>2025-05-03T10:32:23.8414505-05:00</TermEndDate>
      <TermStartDate>2025-05-03T10:32:23.8414505-05:00</TermStartDate>
      <Vendor>sample string 11</Vendor>
    </Asset>
    <Asset>
      <AssetInfo>sample string 24</AssetInfo>
      <BillingAddress>sample string 32</BillingAddress>
      <BillingCity>sample string 33</BillingCity>
      <BillingCountry>sample string 37</BillingCountry>
      <BillingPostalCode>sample string 36</BillingPostalCode>
      <BillingRegion>sample string 35</BillingRegion>
      <BillingState>sample string 34</BillingState>
      <CDF01>sample string 13</CDF01>
      <CDF02>sample string 14</CDF02>
      <CDF03>sample string 15</CDF03>
      <CDF04>sample string 16</CDF04>
      <CDF05>sample string 17</CDF05>
      <CDF06>sample string 18</CDF06>
      <CDF07>sample string 19</CDF07>
      <CDF08>sample string 20</CDF08>
      <CDF09>sample string 21</CDF09>
      <CDF10>sample string 22</CDF10>
      <CMDB_ID>sample string 39</CMDB_ID>
      <Currency>sample string 23</Currency>
      <CustomerReference>sample string 12</CustomerReference>
      <DateAccepted>2025-05-03T10:32:23.8414505-05:00</DateAccepted>
      <ID>1</ID>
      <InventoryId>1</InventoryId>
      <LastModified>2025-05-03T10:32:23.8414505-05:00</LastModified>
      <Lease>sample string 2</Lease>
      <Lessee>sample string 10</Lessee>
      <LessorCountry>sample string 8</LessorCountry>
      <LessorCountryCode>sample string 9</LessorCountryCode>
      <Manufacturer>sample string 6</Manufacturer>
      <Model>sample string 7</Model>
      <NonLeased>true</NonLeased>
      <PaymentCode>sample string 42</PaymentCode>
      <PaymentFrequency>sample string 41</PaymentFrequency>
      <Rent>1</Rent>
      <Returned>sample string 40</Returned>
      <Schedule>sample string 4</Schedule>
      <ScheduleID>3</ScheduleID>
      <Serial>sample string 5</Serial>
      <SiteAddress>sample string 25</SiteAddress>
      <SiteCity>sample string 26</SiteCity>
      <SiteCountry>sample string 31</SiteCountry>
      <SiteLocale>sample string 28</SiteLocale>
      <SitePostalCode>sample string 30</SitePostalCode>
      <SiteRegion>sample string 29</SiteRegion>
      <SiteState>sample string 27</SiteState>
      <Tax>1</Tax>
      <TermEndDate>2025-05-03T10:32:23.8414505-05:00</TermEndDate>
      <TermStartDate>2025-05-03T10:32:23.8414505-05:00</TermStartDate>
      <Vendor>sample string 11</Vendor>
    </Asset>
  </Assets>
</AssetModel>