API - Get Assets

Purpose

A post API to get a list of assets.

Accessing the API

XML
Endpoint: /API/APP/APP007/GetAssets

HTTP METHOD

XML
POST


Parameters

Parameters

Data Type

Required

Description

Filter

String

YES

All/Active/Inactive

AssetType

String

YES

Asset type to select assets with provided value

Instance

String

YES

 Instance name


Sample Request (JSON)

XML
{
	"Filter":"all",
	"AssetType":"",
	"Instance":"Default"
}

Sample Response (JSON)

XML
{
	“Version”:”6.0.0.0”,
	"IsSuccess":true,
	"LogCode":"0",
	"Result":"[
	  {
		"AssetCategory": "Operating System",
		"AssetType": "Unix Based",
		"AssetHost": "Host",
		"IPAddress": "IPAddress",
		"DBInstance": "DBInstance",
		"CreatedBy": "CreatedBy",
		"CreatedOn": "16 Dec 2017 13:43:20 GMT 05:30:00",
		"Status": "Active"
	  },
	  {
		"AssetCategory": "Directory Server",
		"AssetType": "WindowsActiveDirectory",		
		"AssetHost": "HostName",
		"IPAddress": "IPAddress",
		"DBInstance": "DBInstance",
		"CreatedBy": "CreatedBy",
		"CreatedOn": "15 Jul 2017 00:00:00 GMT 05:30:00",
		"Status": "Active"
	  }
	]",
	"StatusCode":"Accepted",
	"Timestamp":"03 Jun 2019 11:51:26 GMT 05:30:00"
}

Standard Error Response Codes

Error Code

Error Description

011649

Current user do not have permission to take an action

011651

The authorization header is either empty or not basic

011673

Invalid credentials

011674

Invalid credentials

011675

Unable to validate request

011683

Invalid instance name

011803

Unable to insert API log details

032409

Unable to get asset

011809

Unable to get asset