Resource Inventory

Developer Portal

Change

Resource Inventory

Service Order

Trouble Ticket

Back

Resource Inventory

Released on Mar-19-2021

TMF version: TMF639 v4.1

Protocols: REST

Bell version: v1.6

Last updated: Jun-03-2023

Swagger

Specification file

Overview
GET /Resource
GET /Resource/{id}

Business overview

The following document is the specification of the REST API for the Resource Inventory (Physical and Logical). It includes the model definition as well as all available operations. The main action that can be performed is to retrieve logical and physical resource inventory. Furthermore, the GET allows filtering using standard filter criteria.

The Resource Inventory API provides a standardized client interface to Resource Inventory Management for creating, tracking and managing logical and physical resources by a customer or another system. In our case, the API is focused on retrieval. Examples of Resource Inventory API originators (clients) include network management or fault management systems.

Resource is an abstract entity. The intent is to describe the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.

Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory. Physical resources can also represent things that are sold, leased, and so forth, like a phone and SIM card.

Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses, Topological Link, etc.).

The Resource Inventory API supports the following functions:

Sr No.	Operation	Flow	Origin	Description
1	List Resources	Partner To Bell	Customer Initiated	Partner requests to retrieve a list of CIs depending on the search parameters.
2	Retrieve Resource	Partner To Bell	Customer Initiated	Partner requests to retrieve the full details of a specific CI.

GET /Resource

Curl
Python
PHP
Java

Example Request

curl --request GET \
  --url '' \
  --header 'accept: application/json' \
  --header 'SECURITY_CREDENTIALS' 
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

Example Response

[
  {
    "category": "lezk",
    "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
    "id": "6823227638677504",
    "lifecycleState": "CA",
    "name": "Jayden Olson",
    "resourceRelationship": [
      {
        "type": "CI_Environment",
        "resourceRef": {
          "id": null
        }
      }
    ],
    "characteristic": [
      {
        "name": "Belle Bryant",
        "value": "egcacso",
        "@type": "leosiho",
        "@schemaLocation": "ovecipca"
      }
    ],
    "place": {
      "characteristic": [
        {
          "name": "CILocation",
          "value": "000000000460763427971"
        },
        {
          "name": "SiteAddress",
          "value": "PRINCIPALE FLOOR - RC"
        }
      ],
      "geographicAddress": {
        "streetNr": "70",
        "streetName": "louis st.",
        "postcode": "",
        "city": "",
        "stateOrProvince": "",
        "country": "CA"
      }
    },
    "relatedParty": [
      {
        "characteristic": [
          {
            "name": "customerCode",
            "value": "GTDE"
          },
          {
            "name": "storeNumber",
            "value": null
          }
        ]
      }
    ],
    "entitySpec": [
      {
        "bl_manufacturer": null,
        "infoclass": "Circuit",
        "makeandmodel": null,
        "service": "IPVPN",
        "servicestartdate": "2013-12-04T05:00:00.000Z"
      }
    ],
    "resourceType": "unknown",
    "managementIpAddress": null,
    "serialNumber": null,
    "lastUpdated": "2020-03-19T20:23:03.000Z",
    "statusChangeDate": "2018-08-02T04:00:00.000Z",
    "type": "lihunn",
    "@schemaLocation": "lucu",
    "@baseType": "urubihog"
  }
]

Example Request

import http.client

conn = http.client.HTTPSConnection("")

headers = {
    'SECURITY_CREDENTIALS',
    'accept': "application/json",
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("GET", "", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

 [
  {
    "category": "lezk",
    "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
    "id": "6823227638677504",
    "lifecycleState": "CA",
    "name": "Jayden Olson",
    "resourceRelationship": [
      {
        "type": "CI_Environment",
        "resourceRef": {
          "id": null
        }
      }
    ],
    "characteristic": [
      {
        "name": "Belle Bryant",
        "value": "egcacso",
        "@type": "leosiho",
        "@schemaLocation": "ovecipca"
      }
    ],
    "place": {
      "characteristic": [
        {
          "name": "CILocation",
          "value": "000000000460763427971"
        },
        {
          "name": "SiteAddress",
          "value": "PRINCIPALE FLOOR - RC"
        }
      ],
      "geographicAddress": {
        "streetNr": "70",
        "streetName": "louis st.",
        "postcode": "",
        "city": "",
        "stateOrProvince": "",
        "country": "CA"
      }
    },
    "relatedParty": [
      {
        "characteristic": [
          {
            "name": "customerCode",
            "value": "GTDE"
          },
          {
            "name": "storeNumber",
            "value": null
          }
        ]
      }
    ],
    "entitySpec": [
      {
        "bl_manufacturer": null,
        "infoclass": "Circuit",
        "makeandmodel": null,
        "service": "IPVPN",
        "servicestartdate": "2013-12-04T05:00:00.000Z"
      }
    ],
    "resourceType": "unknown",
    "managementIpAddress": null,
    "serialNumber": null,
    "lastUpdated": "2020-03-19T20:23:03.000Z",
    "statusChangeDate": "2018-08-02T04:00:00.000Z",
    "type": "lihunn",
    "@schemaLocation": "lucu",
    "@baseType": "urubihog"
  }
]

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
   'SECURITY_CREDENTIALS',
   'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

 [
  {
    "category": "lezk",
    "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
    "id": "6823227638677504",
    "lifecycleState": "CA",
    "name": "Jayden Olson",
    "resourceRelationship": [
      {
        "type": "CI_Environment",
        "resourceRef": {
          "id": null
        }
      }
    ],
    "characteristic": [
      {
        "name": "Belle Bryant",
        "value": "egcacso",
        "@type": "leosiho",
        "@schemaLocation": "ovecipca"
      }
    ],
    "place": {
      "characteristic": [
        {
          "name": "CILocation",
          "value": "000000000460763427971"
        },
        {
          "name": "SiteAddress",
          "value": "PRINCIPALE FLOOR - RC"
        }
      ],
      "geographicAddress": {
        "streetNr": "70",
        "streetName": "louis st.",
        "postcode": "",
        "city": "",
        "stateOrProvince": "",
        "country": "CA"
      }
    },
    "relatedParty": [
      {
        "characteristic": [
          {
            "name": "customerCode",
            "value": "GTDE"
          },
          {
            "name": "storeNumber",
            "value": null
          }
        ]
      }
    ],
    "entitySpec": [
      {
        "bl_manufacturer": null,
        "infoclass": "Circuit",
        "makeandmodel": null,
        "service": "IPVPN",
        "servicestartdate": "2013-12-04T05:00:00.000Z"
      }
    ],
    "resourceType": "unknown",
    "managementIpAddress": null,
    "serialNumber": null,
    "lastUpdated": "2020-03-19T20:23:03.000Z",
    "statusChangeDate": "2018-08-02T04:00:00.000Z",
    "type": "lihunn",
    "@schemaLocation": "lucu",
    "@baseType": "urubihog"
  }
]

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("")
  .get()
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("accept", "application/json")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

 [
  {
    "category": "lezk",
    "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
    "id": "6823227638677504",
    "lifecycleState": "CA",
    "name": "Jayden Olson",
    "resourceRelationship": [
      {
        "type": "CI_Environment",
        "resourceRef": {
          "id": null
        }
      }
    ],
    "characteristic": [
      {
        "name": "Belle Bryant",
        "value": "egcacso",
        "@type": "leosiho",
        "@schemaLocation": "ovecipca"
      }
    ],
    "place": {
      "characteristic": [
        {
          "name": "CILocation",
          "value": "000000000460763427971"
        },
        {
          "name": "SiteAddress",
          "value": "PRINCIPALE FLOOR - RC"
        }
      ],
      "geographicAddress": {
        "streetNr": "70",
        "streetName": "louis st.",
        "postcode": "",
        "city": "",
        "stateOrProvince": "",
        "country": "CA"
      }
    },
    "relatedParty": [
      {
        "characteristic": [
          {
            "name": "customerCode",
            "value": "GTDE"
          },
          {
            "name": "storeNumber",
            "value": null
          }
        ]
      }
    ],
    "entitySpec": [
      {
        "bl_manufacturer": null,
        "infoclass": "Circuit",
        "makeandmodel": null,
        "service": "IPVPN",
        "servicestartdate": "2013-12-04T05:00:00.000Z"
      }
    ],
    "resourceType": "unknown",
    "managementIpAddress": null,
    "serialNumber": null,
    "lastUpdated": "2020-03-19T20:23:03.000Z",
    "statusChangeDate": "2018-08-02T04:00:00.000Z",
    "type": "lihunn",
    "@schemaLocation": "lucu",
    "@baseType": "urubihog"
  }
]

Path

GET/Resource

Parameters

fields		Comma separated properties to display in response
Optional In Query
string

offset		Requested index for start of resources to be provided in response
Optional In Query
Integer

limit		Requested number of resources to be provided in response
Optional In Query
Integer

sort		To have the output sorted by fields. Can support one or many fields, as well as ascending and descending sort order
Optional In Query
string

expand		Lists the sub-entities to expand along with the depth value. Empty means expand all at depth level N
Optional In Query
string

depth		Depth level where objects are dereferenced and inserted as values into the response
Optional In Query
string

Accept		application/json
Optional in header
string

Response

200

Resource []

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

GET /Resource/{id}

Curl
Python
PHP
Java

Example Request

curl --request GET \
  --url '' \
  --header 'accept: application/json' \
  --header 'SECURITY_CREDENTIALS' 
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

Example Response

{
  "id": "6823227638677504",
  "category": "lezk",
  "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
  "lifecycleState": "CA",
  "name": "Jayden Olson",
  "resourceRelationship": [
    {
      "type": "CI_Environment",
      "resourceRef": {
        "id": null
      }
    }
  ],
  "characteristic": [
    {
      "name": "Belle Bryant",
      "value": "egcacso",
      "@type": "leosiho",
      "@schemaLocation": "ovecipca"
    }
  ],
  "place": {
    "characteristic": [
      {
        "name": "CILocation",
        "value": "000000000460763427971"
      },
      {
        "name": "SiteAddress",
        "value": "PRINCIPALE FLOOR - RC"
      }
    ],
    "geographicAddress": {
      "streetNr": "70",
      "streetName": "louis st.",
      "postcode": "",
      "city": "",
      "stateOrProvince": "",
      "country": "CA"
    }
  },
  "relatedParty": [
    {
      "characteristic": [
        {
          "name": "customerCode",
          "value": "GTDE"
        },
        {
          "name": "storeNumber",
          "value": null
        }
      ]
    }
  ],
  "entitySpec": [
    {
      "bl_manufacturer": null,
      "infoclass": "Circuit",
      "makeandmodel": null,
      "service": "IPVPN",
      "servicestartdate": "2013-12-04T05:00:00.000Z"
    }
  ],
  "resourceType": "unknown",
  "managementIpAddress": null,
  "serialNumber": null,
  "lastUpdated": "2020-03-19T20:23:03.000Z",
  "statusChangeDate": "2018-08-02T04:00:00.000Z",
  "type": "lihunn",
  "@schemaLocation": "lucu",
  "@baseType": "urubihog"
}

Example Request

import http.client

conn = http.client.HTTPSConnection("")

headers = {
   'SECURITY_CREDENTIALS',
    'accept': "application/json",
    --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("GET", "", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
  "id": "6823227638677504",
  "category": "lezk",
  "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
  "lifecycleState": "CA",
  "name": "Jayden Olson",
  "resourceRelationship": [
    {
      "type": "CI_Environment",
      "resourceRef": {
        "id": null
      }
    }
  ],
  "characteristic": [
    {
      "name": "Belle Bryant",
      "value": "egcacso",
      "@type": "leosiho",
      "@schemaLocation": "ovecipca"
    }
  ],
  "place": {
    "characteristic": [
      {
        "name": "CILocation",
        "value": "000000000460763427971"
      },
      {
        "name": "SiteAddress",
        "value": "PRINCIPALE FLOOR - RC"
      }
    ],
    "geographicAddress": {
      "streetNr": "70",
      "streetName": "louis st.",
      "postcode": "",
      "city": "",
      "stateOrProvince": "",
      "country": "CA"
    }
  },
  "relatedParty": [
    {
      "characteristic": [
        {
          "name": "customerCode",
          "value": "GTDE"
        },
        {
          "name": "storeNumber",
          "value": null
        }
      ]
    }
  ],
  "entitySpec": [
    {
      "bl_manufacturer": null,
      "infoclass": "Circuit",
      "makeandmodel": null,
      "service": "IPVPN",
      "servicestartdate": "2013-12-04T05:00:00.000Z"
    }
  ],
  "resourceType": "unknown",
  "managementIpAddress": null,
  "serialNumber": null,
  "lastUpdated": "2020-03-19T20:23:03.000Z",
  "statusChangeDate": "2018-08-02T04:00:00.000Z",
  "type": "lihunn",
  "@schemaLocation": "lucu",
  "@baseType": "urubihog"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
   'SECURITY_CREDENTIALS',
   'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

{
  "id": "6823227638677504",
  "category": "lezk",
  "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
  "lifecycleState": "CA",
  "name": "Jayden Olson",
  "resourceRelationship": [
    {
      "type": "CI_Environment",
      "resourceRef": {
        "id": null
      }
    }
  ],
  "characteristic": [
    {
      "name": "Belle Bryant",
      "value": "egcacso",
      "@type": "leosiho",
      "@schemaLocation": "ovecipca"
    }
  ],
  "place": {
    "characteristic": [
      {
        "name": "CILocation",
        "value": "000000000460763427971"
      },
      {
        "name": "SiteAddress",
        "value": "PRINCIPALE FLOOR - RC"
      }
    ],
    "geographicAddress": {
      "streetNr": "70",
      "streetName": "louis st.",
      "postcode": "",
      "city": "",
      "stateOrProvince": "",
      "country": "CA"
    }
  },
  "relatedParty": [
    {
      "characteristic": [
        {
          "name": "customerCode",
          "value": "GTDE"
        },
        {
          "name": "storeNumber",
          "value": null
        }
      ]
    }
  ],
  "entitySpec": [
    {
      "bl_manufacturer": null,
      "infoclass": "Circuit",
      "makeandmodel": null,
      "service": "IPVPN",
      "servicestartdate": "2013-12-04T05:00:00.000Z"
    }
  ],
  "resourceType": "unknown",
  "managementIpAddress": null,
  "serialNumber": null,
  "lastUpdated": "2020-03-19T20:23:03.000Z",
  "statusChangeDate": "2018-08-02T04:00:00.000Z",
  "type": "lihunn",
  "@schemaLocation": "lucu",
  "@baseType": "urubihog"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("")
  .get()
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("accept", "application/json")
 .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

{
  "id": "6823227638677504",
  "category": "lezk",
  "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
  "lifecycleState": "CA",
  "name": "Jayden Olson",
  "resourceRelationship": [
    {
      "type": "CI_Environment",
      "resourceRef": {
        "id": null
      }
    }
  ],
  "characteristic": [
    {
      "name": "Belle Bryant",
      "value": "egcacso",
      "@type": "leosiho",
      "@schemaLocation": "ovecipca"
    }
  ],
  "place": {
    "characteristic": [
      {
        "name": "CILocation",
        "value": "000000000460763427971"
      },
      {
        "name": "SiteAddress",
        "value": "PRINCIPALE FLOOR - RC"
      }
    ],
    "geographicAddress": {
      "streetNr": "70",
      "streetName": "louis st.",
      "postcode": "",
      "city": "",
      "stateOrProvince": "",
      "country": "CA"
    }
  },
  "relatedParty": [
    {
      "characteristic": [
        {
          "name": "customerCode",
          "value": "GTDE"
        },
        {
          "name": "storeNumber",
          "value": null
        }
      ]
    }
  ],
  "entitySpec": [
    {
      "bl_manufacturer": null,
      "infoclass": "Circuit",
      "makeandmodel": null,
      "service": "IPVPN",
      "servicestartdate": "2013-12-04T05:00:00.000Z"
    }
  ],
  "resourceType": "unknown",
  "managementIpAddress": null,
  "serialNumber": null,
  "lastUpdated": "2020-03-19T20:23:03.000Z",
  "statusChangeDate": "2018-08-02T04:00:00.000Z",
  "type": "lihunn",
  "@schemaLocation": "lucu",
  "@baseType": "urubihog"
}

Path

Get/Resource/{id}

Parameters

id		Identifier of the Resource
Required in path
string

expand		Lists the sub-entities to expand along with the depth value. Empty means expand all at depth level N
Optional In Query
string

depth		Depth level where objects are dereferenced and inserted as values into the response
Optional In Query
string

fields		Comma separated properties to display in response
Optional In Query
string

Accept		application/json
Optional in header
string

Response

200

Resource []

400

Bad Request

ErrorRepresentation

404

Not Found

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

Business overview

Resource is an abstract entity. The intent is to describe the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.

Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses, Topological Link, etc.).

The Resource Inventory API supports the following functions:

Sr No.	Operation	Flow	Origin	Description
1	List Resources	Partner To Bell	Customer Initiated	Partner requests to retrieve a list of CIs depending on the search parameters.
2	Retrieve Resource	Partner To Bell	Customer Initiated	Partner requests to retrieve the full details of a specific CI.

GET /Resource

Curl
Python
PHP
Java

Example Request

curl --request GET \
  --url '' \
  --header 'accept: application/json' \
  --header 'SECURITY_CREDENTIALS' 
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

Example Response

[
  {
    "category": "lezk",
    "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
    "id": "6823227638677504",
    "lifecycleState": "CA",
    "name": "Jayden Olson",
    "resourceRelationship": [
      {
        "type": "CI_Environment",
        "resourceRef": {
          "id": null
        }
      }
    ],
    "characteristic": [
      {
        "name": "Belle Bryant",
        "value": "egcacso",
        "@type": "leosiho",
        "@schemaLocation": "ovecipca"
      }
    ],
    "place": {
      "characteristic": [
        {
          "name": "CILocation",
          "value": "000000000460763427971"
        },
        {
          "name": "SiteAddress",
          "value": "PRINCIPALE FLOOR - RC"
        }
      ],
      "geographicAddress": {
        "streetNr": "70",
        "streetName": "louis st.",
        "postcode": "",
        "city": "",
        "stateOrProvince": "",
        "country": "CA"
      }
    },
    "relatedParty": [
      {
        "characteristic": [
          {
            "name": "customerCode",
            "value": "GTDE"
          },
          {
            "name": "storeNumber",
            "value": null
          }
        ]
      }
    ],
    "entitySpec": [
      {
        "bl_manufacturer": null,
        "infoclass": "Circuit",
        "makeandmodel": null,
        "service": "IPVPN",
        "servicestartdate": "2013-12-04T05:00:00.000Z"
      }
    ],
    "resourceType": "unknown",
    "managementIpAddress": null,
    "serialNumber": null,
    "lastUpdated": "2020-03-19T20:23:03.000Z",
    "statusChangeDate": "2018-08-02T04:00:00.000Z",
    "type": "lihunn",
    "@schemaLocation": "lucu",
    "@baseType": "urubihog"
  }
]

Example Request

import http.client

conn = http.client.HTTPSConnection("")

headers = {
    'SECURITY_CREDENTIALS',
    'accept': "application/json",
    'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("GET", "", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

 [
  {
    "category": "lezk",
    "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
    "id": "6823227638677504",
    "lifecycleState": "CA",
    "name": "Jayden Olson",
    "resourceRelationship": [
      {
        "type": "CI_Environment",
        "resourceRef": {
          "id": null
        }
      }
    ],
    "characteristic": [
      {
        "name": "Belle Bryant",
        "value": "egcacso",
        "@type": "leosiho",
        "@schemaLocation": "ovecipca"
      }
    ],
    "place": {
      "characteristic": [
        {
          "name": "CILocation",
          "value": "000000000460763427971"
        },
        {
          "name": "SiteAddress",
          "value": "PRINCIPALE FLOOR - RC"
        }
      ],
      "geographicAddress": {
        "streetNr": "70",
        "streetName": "louis st.",
        "postcode": "",
        "city": "",
        "stateOrProvince": "",
        "country": "CA"
      }
    },
    "relatedParty": [
      {
        "characteristic": [
          {
            "name": "customerCode",
            "value": "GTDE"
          },
          {
            "name": "storeNumber",
            "value": null
          }
        ]
      }
    ],
    "entitySpec": [
      {
        "bl_manufacturer": null,
        "infoclass": "Circuit",
        "makeandmodel": null,
        "service": "IPVPN",
        "servicestartdate": "2013-12-04T05:00:00.000Z"
      }
    ],
    "resourceType": "unknown",
    "managementIpAddress": null,
    "serialNumber": null,
    "lastUpdated": "2020-03-19T20:23:03.000Z",
    "statusChangeDate": "2018-08-02T04:00:00.000Z",
    "type": "lihunn",
    "@schemaLocation": "lucu",
    "@baseType": "urubihog"
  }
]

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
   'SECURITY_CREDENTIALS',
   'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

 [
  {
    "category": "lezk",
    "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
    "id": "6823227638677504",
    "lifecycleState": "CA",
    "name": "Jayden Olson",
    "resourceRelationship": [
      {
        "type": "CI_Environment",
        "resourceRef": {
          "id": null
        }
      }
    ],
    "characteristic": [
      {
        "name": "Belle Bryant",
        "value": "egcacso",
        "@type": "leosiho",
        "@schemaLocation": "ovecipca"
      }
    ],
    "place": {
      "characteristic": [
        {
          "name": "CILocation",
          "value": "000000000460763427971"
        },
        {
          "name": "SiteAddress",
          "value": "PRINCIPALE FLOOR - RC"
        }
      ],
      "geographicAddress": {
        "streetNr": "70",
        "streetName": "louis st.",
        "postcode": "",
        "city": "",
        "stateOrProvince": "",
        "country": "CA"
      }
    },
    "relatedParty": [
      {
        "characteristic": [
          {
            "name": "customerCode",
            "value": "GTDE"
          },
          {
            "name": "storeNumber",
            "value": null
          }
        ]
      }
    ],
    "entitySpec": [
      {
        "bl_manufacturer": null,
        "infoclass": "Circuit",
        "makeandmodel": null,
        "service": "IPVPN",
        "servicestartdate": "2013-12-04T05:00:00.000Z"
      }
    ],
    "resourceType": "unknown",
    "managementIpAddress": null,
    "serialNumber": null,
    "lastUpdated": "2020-03-19T20:23:03.000Z",
    "statusChangeDate": "2018-08-02T04:00:00.000Z",
    "type": "lihunn",
    "@schemaLocation": "lucu",
    "@baseType": "urubihog"
  }
]

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("")
  .get()
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("accept", "application/json")
  .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

 [
  {
    "category": "lezk",
    "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
    "id": "6823227638677504",
    "lifecycleState": "CA",
    "name": "Jayden Olson",
    "resourceRelationship": [
      {
        "type": "CI_Environment",
        "resourceRef": {
          "id": null
        }
      }
    ],
    "characteristic": [
      {
        "name": "Belle Bryant",
        "value": "egcacso",
        "@type": "leosiho",
        "@schemaLocation": "ovecipca"
      }
    ],
    "place": {
      "characteristic": [
        {
          "name": "CILocation",
          "value": "000000000460763427971"
        },
        {
          "name": "SiteAddress",
          "value": "PRINCIPALE FLOOR - RC"
        }
      ],
      "geographicAddress": {
        "streetNr": "70",
        "streetName": "louis st.",
        "postcode": "",
        "city": "",
        "stateOrProvince": "",
        "country": "CA"
      }
    },
    "relatedParty": [
      {
        "characteristic": [
          {
            "name": "customerCode",
            "value": "GTDE"
          },
          {
            "name": "storeNumber",
            "value": null
          }
        ]
      }
    ],
    "entitySpec": [
      {
        "bl_manufacturer": null,
        "infoclass": "Circuit",
        "makeandmodel": null,
        "service": "IPVPN",
        "servicestartdate": "2013-12-04T05:00:00.000Z"
      }
    ],
    "resourceType": "unknown",
    "managementIpAddress": null,
    "serialNumber": null,
    "lastUpdated": "2020-03-19T20:23:03.000Z",
    "statusChangeDate": "2018-08-02T04:00:00.000Z",
    "type": "lihunn",
    "@schemaLocation": "lucu",
    "@baseType": "urubihog"
  }
]

Path

GET/Resource

Parameters

fields		Comma separated properties to display in response
Optional In Query
string

offset		Requested index for start of resources to be provided in response
Optional In Query
Integer

limit		Requested number of resources to be provided in response
Optional In Query
Integer

sort		To have the output sorted by fields. Can support one or many fields, as well as ascending and descending sort order
Optional In Query
string

expand		Lists the sub-entities to expand along with the depth value. Empty means expand all at depth level N
Optional In Query
string

depth		Depth level where objects are dereferenced and inserted as values into the response
Optional In Query
string

Accept		application/json
Optional in header
string

Response

200

Resource []

400

Bad Request

ErrorRepresentation

401

Unauthorized

ErrorRepresentation

403

Forbidden

ErrorRepresentation

405

Method Not allowed

ErrorRepresentation

409

Conflict

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

GET /Resource/{id}

Curl
Python
PHP
Java

Example Request

curl --request GET \
  --url '' \
  --header 'accept: application/json' \
  --header 'SECURITY_CREDENTIALS' 
  --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)

Example Response

{
  "id": "6823227638677504",
  "category": "lezk",
  "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
  "lifecycleState": "CA",
  "name": "Jayden Olson",
  "resourceRelationship": [
    {
      "type": "CI_Environment",
      "resourceRef": {
        "id": null
      }
    }
  ],
  "characteristic": [
    {
      "name": "Belle Bryant",
      "value": "egcacso",
      "@type": "leosiho",
      "@schemaLocation": "ovecipca"
    }
  ],
  "place": {
    "characteristic": [
      {
        "name": "CILocation",
        "value": "000000000460763427971"
      },
      {
        "name": "SiteAddress",
        "value": "PRINCIPALE FLOOR - RC"
      }
    ],
    "geographicAddress": {
      "streetNr": "70",
      "streetName": "louis st.",
      "postcode": "",
      "city": "",
      "stateOrProvince": "",
      "country": "CA"
    }
  },
  "relatedParty": [
    {
      "characteristic": [
        {
          "name": "customerCode",
          "value": "GTDE"
        },
        {
          "name": "storeNumber",
          "value": null
        }
      ]
    }
  ],
  "entitySpec": [
    {
      "bl_manufacturer": null,
      "infoclass": "Circuit",
      "makeandmodel": null,
      "service": "IPVPN",
      "servicestartdate": "2013-12-04T05:00:00.000Z"
    }
  ],
  "resourceType": "unknown",
  "managementIpAddress": null,
  "serialNumber": null,
  "lastUpdated": "2020-03-19T20:23:03.000Z",
  "statusChangeDate": "2018-08-02T04:00:00.000Z",
  "type": "lihunn",
  "@schemaLocation": "lucu",
  "@baseType": "urubihog"
}

Example Request

import http.client

conn = http.client.HTTPSConnection("")

headers = {
   'SECURITY_CREDENTIALS',
    'accept': "application/json",
    --header 'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
    }

conn.request("GET", "", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

Example Response

{
  "id": "6823227638677504",
  "category": "lezk",
  "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
  "lifecycleState": "CA",
  "name": "Jayden Olson",
  "resourceRelationship": [
    {
      "type": "CI_Environment",
      "resourceRef": {
        "id": null
      }
    }
  ],
  "characteristic": [
    {
      "name": "Belle Bryant",
      "value": "egcacso",
      "@type": "leosiho",
      "@schemaLocation": "ovecipca"
    }
  ],
  "place": {
    "characteristic": [
      {
        "name": "CILocation",
        "value": "000000000460763427971"
      },
      {
        "name": "SiteAddress",
        "value": "PRINCIPALE FLOOR - RC"
      }
    ],
    "geographicAddress": {
      "streetNr": "70",
      "streetName": "louis st.",
      "postcode": "",
      "city": "",
      "stateOrProvince": "",
      "country": "CA"
    }
  },
  "relatedParty": [
    {
      "characteristic": [
        {
          "name": "customerCode",
          "value": "GTDE"
        },
        {
          "name": "storeNumber",
          "value": null
        }
      ]
    }
  ],
  "entitySpec": [
    {
      "bl_manufacturer": null,
      "infoclass": "Circuit",
      "makeandmodel": null,
      "service": "IPVPN",
      "servicestartdate": "2013-12-04T05:00:00.000Z"
    }
  ],
  "resourceType": "unknown",
  "managementIpAddress": null,
  "serialNumber": null,
  "lastUpdated": "2020-03-19T20:23:03.000Z",
  "statusChangeDate": "2018-08-02T04:00:00.000Z",
  "type": "lihunn",
  "@schemaLocation": "lucu",
  "@baseType": "urubihog"
}

Example Request

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
   'SECURITY_CREDENTIALS',
   'x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars)
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Response

{
  "id": "6823227638677504",
  "category": "lezk",
  "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
  "lifecycleState": "CA",
  "name": "Jayden Olson",
  "resourceRelationship": [
    {
      "type": "CI_Environment",
      "resourceRef": {
        "id": null
      }
    }
  ],
  "characteristic": [
    {
      "name": "Belle Bryant",
      "value": "egcacso",
      "@type": "leosiho",
      "@schemaLocation": "ovecipca"
    }
  ],
  "place": {
    "characteristic": [
      {
        "name": "CILocation",
        "value": "000000000460763427971"
      },
      {
        "name": "SiteAddress",
        "value": "PRINCIPALE FLOOR - RC"
      }
    ],
    "geographicAddress": {
      "streetNr": "70",
      "streetName": "louis st.",
      "postcode": "",
      "city": "",
      "stateOrProvince": "",
      "country": "CA"
    }
  },
  "relatedParty": [
    {
      "characteristic": [
        {
          "name": "customerCode",
          "value": "GTDE"
        },
        {
          "name": "storeNumber",
          "value": null
        }
      ]
    }
  ],
  "entitySpec": [
    {
      "bl_manufacturer": null,
      "infoclass": "Circuit",
      "makeandmodel": null,
      "service": "IPVPN",
      "servicestartdate": "2013-12-04T05:00:00.000Z"
    }
  ],
  "resourceType": "unknown",
  "managementIpAddress": null,
  "serialNumber": null,
  "lastUpdated": "2020-03-19T20:23:03.000Z",
  "statusChangeDate": "2018-08-02T04:00:00.000Z",
  "type": "lihunn",
  "@schemaLocation": "lucu",
  "@baseType": "urubihog"
}

Example Request

// OkHttpClient from http://square.github.io/okhttp/

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("")
  .get()
  .addHeader('SECURITY_CREDENTIALS')
  .addHeader("accept", "application/json")
 .addHeader('x-external-system' \ (for use in sandbox mode only, pass any unique value >= 8 chars))
  .build();

Response response = client.newCall(request).execute();

Example Response

{
  "id": "6823227638677504",
  "category": "lezk",
  "description": "Be sig upzuip vifefiv ufawejtu vafbe bekwih culablac pulonlin gobute kafehpi udfef va.",
  "lifecycleState": "CA",
  "name": "Jayden Olson",
  "resourceRelationship": [
    {
      "type": "CI_Environment",
      "resourceRef": {
        "id": null
      }
    }
  ],
  "characteristic": [
    {
      "name": "Belle Bryant",
      "value": "egcacso",
      "@type": "leosiho",
      "@schemaLocation": "ovecipca"
    }
  ],
  "place": {
    "characteristic": [
      {
        "name": "CILocation",
        "value": "000000000460763427971"
      },
      {
        "name": "SiteAddress",
        "value": "PRINCIPALE FLOOR - RC"
      }
    ],
    "geographicAddress": {
      "streetNr": "70",
      "streetName": "louis st.",
      "postcode": "",
      "city": "",
      "stateOrProvince": "",
      "country": "CA"
    }
  },
  "relatedParty": [
    {
      "characteristic": [
        {
          "name": "customerCode",
          "value": "GTDE"
        },
        {
          "name": "storeNumber",
          "value": null
        }
      ]
    }
  ],
  "entitySpec": [
    {
      "bl_manufacturer": null,
      "infoclass": "Circuit",
      "makeandmodel": null,
      "service": "IPVPN",
      "servicestartdate": "2013-12-04T05:00:00.000Z"
    }
  ],
  "resourceType": "unknown",
  "managementIpAddress": null,
  "serialNumber": null,
  "lastUpdated": "2020-03-19T20:23:03.000Z",
  "statusChangeDate": "2018-08-02T04:00:00.000Z",
  "type": "lihunn",
  "@schemaLocation": "lucu",
  "@baseType": "urubihog"
}

Path

Get/Resource/{id}

Parameters

id		Identifier of the Resource
Required in path
string

expand		Lists the sub-entities to expand along with the depth value. Empty means expand all at depth level N
Optional In Query
string

depth		Depth level where objects are dereferenced and inserted as values into the response
Optional In Query
string

fields		Comma separated properties to display in response
Optional In Query
string

Accept		application/json
Optional in header
string

Response

200

Resource []

400

Bad Request

ErrorRepresentation

404

Not Found

ErrorRepresentation

500

Internal Server Error

ErrorRepresentation

Ready to get started?