Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Exporter macro migration
Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
#F0F0F0#F0F0F0

3

Scroll export button
scopecurrent
template-id4fda9400-a7df-4ede-a95f-e4ae5fcf4796
captionDownload this Page
add-onScroll PDF Exporter

You can retrieve all the details of a specific CI using the serial number, classification, or device host name of the CI. Use the following API Request to retrieve the details of a CI in the CMDB.

To authenticate the below API, see API Authentication and Authorization.

Service NameHTTP Method
CMDB_LoadCIRecords

POST

Below are the sample request to retrieve a CI.

Ui tabs
Ui tab
titleRetrieving a CI
DJangoSample Requesttrue

New StatusRequest Parameters

Parameter NameTypeDescriptionMandatory
InstanceName

GreenString

Name of the Instance.

For Example: Info

GreenTrue

Device_Host_Name

GreenString

Name of the Device or the Host.

GreenTrue

Serial_No

GreenString

Unique Serial number of the CI.

GreenTrue

Classification

GreenString

Classification of the CI.

GreenTrue

DJangoSample Responsetrue
Ui tab
titleCI with Classification
DJangoSample Requesttrue

New StatusRequest Parameters

Parameter NameTypeDescriptionMandatory
InstanceName

GreenString

Name of the Instance.

For Example: Info

GreenTrue

Classification

GreenString

Classification of the CI.

GreenTrue

IsIncludeInactive

GreenString

Indicates whether the CI is active state or not.

  • If the value is true, the CI becomes inactive.
  • If the value is false, the CI becomes active.

GreyFALSE

CurrentPageIndex

Greyinteger

Current Index of the page that you are looking into.

For Example:

If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the  CurrentPageIndex value as 1.

GreyFALSE

PageSize

Greyinteger

Number of records that should be displayed per each page.

For Example:

Consider you specified the PageSize value as 100. Based on the CurrentPageIndex, the API Response displays 100 records.

GreyFALSE

DJangoSample Responsetrue
Ui tab
titleCI with Classification Hierarchy
DJangoSample Requesttrue

New StatusRequest Parameters

Parameter NameTypeMandatoryDescriptionNotes
InstanceName

GreenString

GreenTrue

Name of the Instance.

For Example: Info


Classification

GreenString

GreenTrue

Classification of the CI.

The classification name of the CI with the child inside should be specified as follows:

For Example:

  • "Server\\Wintel Server" is an example of Parent\\Child in which Server is the Parent and Wintel Server is the child. Both are separated using \\.

IsIncludeInactive

GreenString

GreyFALSE

Indicates whether the CI is active state or not.

  • If the value is true, the CI becomes inactive.
  • If the value is false, the CI becomes active.

CurrentPageIndex

Greyinteger

GreyFALSE

Current Index of the page that you are looking into.

For Example:

If each page contains 10 records and there are 10 pages. Items from 1 to 10 are displayed when you specify the  CurrentPageIndex value as 1.


PageSize

Greyinteger

GreyFALSE

Number of records that should be displayed per each page.

For Example:

Consider you specified the PageSize value as 100. Based on the CurrentPageIndex, the API Response displays 100 records.


DJangoSample Responsetrue


Status and Error Codes

For more information, see Status and Error Messages

Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
1

| |