Api Home > Config > GetConfigItemsByClass

GET api/V3/Config/GetConfigItemsByClass?userId={userId}&isUserScoped={isUserScoped}&searchFilter={searchFilter}&objectClassId={objectClassId} Returns a list of Configuration Items that have a Class Id in the provided list.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

The User Id

globally unique identifier

Required

isUserScoped

Boolean whether the user has configuration item scoping

boolean

Required

searchFilter

The filter text

string

Required

objectClassId

The Configuration Object Class Id

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of ConfigItemObject
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

ObjectClassId

globally unique identifier

None.

ObjectClassName

string

None.

DisplayName

string

None.

Path

string

None.

BaseType

string

None.

Hosted

integer

None.

LastModified

date

None.

AssetStatus

AssetStatus

None.

LastModifiedAsString

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "b773e77e-b79e-46a8-a3cd-aac6d37c427e",
    "ObjectClassId": "84018522-4202-4d2c-8995-886495df3101",
    "ObjectClassName": "sample string 3",
    "DisplayName": "sample string 4",
    "Path": "sample string 5",
    "BaseType": "sample string 6",
    "Hosted": 7,
    "LastModified": "2019-12-08T01:26:57.447Z",
    "AssetStatus": {
      "Id": "9d4b824c-7d8d-40cb-bc02-5cd9b29630cf",
      "Name": "sample string 2"
    },
    "LastModifiedAsString": "2019-12-08T01:26:57.447Z"
  },
  {
    "Id": "b773e77e-b79e-46a8-a3cd-aac6d37c427e",
    "ObjectClassId": "84018522-4202-4d2c-8995-886495df3101",
    "ObjectClassName": "sample string 3",
    "DisplayName": "sample string 4",
    "Path": "sample string 5",
    "BaseType": "sample string 6",
    "Hosted": 7,
    "LastModified": "2019-12-08T01:26:57.447Z",
    "AssetStatus": {
      "Id": "9d4b824c-7d8d-40cb-bc02-5cd9b29630cf",
      "Name": "sample string 2"
    },
    "LastModifiedAsString": "2019-12-08T01:26:57.447Z"
  }
]

application/xml, text/xml

Sample:
<ArrayOfConfigItemObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Library">
  <ConfigItemObject>
    <AssetStatus>
      <Id>9d4b824c-7d8d-40cb-bc02-5cd9b29630cf</Id>
      <Name>sample string 2</Name>
    </AssetStatus>
    <BaseType>sample string 6</BaseType>
    <DisplayName>sample string 4</DisplayName>
    <Hosted>7</Hosted>
    <Id>b773e77e-b79e-46a8-a3cd-aac6d37c427e</Id>
    <LastModified>2019-12-08T01:26:57.4478229+00:00</LastModified>
    <LastModifiedAsString>2019-12-08T01:26:57.447</LastModifiedAsString>
    <ObjectClassId>84018522-4202-4d2c-8995-886495df3101</ObjectClassId>
    <ObjectClassName>sample string 3</ObjectClassName>
    <Path>sample string 5</Path>
  </ConfigItemObject>
  <ConfigItemObject>
    <AssetStatus>
      <Id>9d4b824c-7d8d-40cb-bc02-5cd9b29630cf</Id>
      <Name>sample string 2</Name>
    </AssetStatus>
    <BaseType>sample string 6</BaseType>
    <DisplayName>sample string 4</DisplayName>
    <Hosted>7</Hosted>
    <Id>b773e77e-b79e-46a8-a3cd-aac6d37c427e</Id>
    <LastModified>2019-12-08T01:26:57.4478229+00:00</LastModified>
    <LastModifiedAsString>2019-12-08T01:26:57.447</LastModifiedAsString>
    <ObjectClassId>84018522-4202-4d2c-8995-886495df3101</ObjectClassId>
    <ObjectClassName>sample string 3</ObjectClassName>
    <Path>sample string 5</Path>
  </ConfigItemObject>
</ArrayOfConfigItemObject>