Versions Compared

Old Version 3

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: GET /rest/dspcard/{identifier}

dspcard - REST API Methods
Page Tree
rootResource - dspcard

Retrieves all resource schema elements and values of a DSP Card based on a requested ID.

Tip

If no ID is specified in the GET, a listing of all DSP Cards will be returned along with their associated IDs. These identifiers can be used to collect resource schema element values via the GET dspcard id method.

Info

Querying this resource without any filter results in obtaining inventory information which often increases CPU utilization by about 5% and should be avoided in a production system, specially with heavy traffic.

If this resource is queried from a production system, it is recommended to pass the URI parameter 'filter=runtime'.

URL:

https://

...

192.

...

168.

...

0.

...

111/rest/dspcard/{identifier}

HTTP Method

GET

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[dspcard - REST API Methods|Resource - dspcard]

Page Tree
root@parent

Parameters

Name Required Values Description
filterNo
  • runtime
  • inventory
The type of filtered information in the response. If no filters are specified, all get applied

...

Usage Example: (about cURL | requires a session token)

Code Block
languagebash
curl --cookie PHPSESSID=ima0r3nkaeg8mo0suln67vg4m7 --cacert 134.56.227.163.crt 
-i https://134.56.227.163/rest/dspcard/1

Response:

...

languagehtml/xml

...

.

...