SAsalesforce
perspectives

Get perspective

Retrieve the specified perspective by its id or name. You may also optionally specify a list of fields to include in the response.

get/perspectives/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/perspectives/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The id or name of the perspective to retrieve.

Query parameters

fieldsstring[]

Comma-delimited list of field names to include in the response.

Response

Success, returns the specified perspective.

idstring
namestring

The name of the perspective.

rootSubjectstring

The absolute path of the root subject.

aspectFilterstring[]

Array of aspect names to filter; Aspect name: Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-).

aspectTagFilterstring[]

Array of aspect tag names to filter; Tag name: Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-).

subjectTagFilterstring[]

Array of subject tag names to filter; Tag name: Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-).

aspectFilterType'INCLUDE' | 'EXCLUDE'
aspectTagFilterType'INCLUDE' | 'EXCLUDE'
subjectTagFilterType'INCLUDE' | 'EXCLUDE'
statusFilterstring[]

Array of sample status to filter; Status values can only be one of these: Critical, Invalid, Timeout, Warning, Info, OK, -Critical, -Invalid, -Timeout, -Warning, -Info, -OK.

createdBystring

TODO

createdAtstring

TODO

updatedAtstring

TODO

lensIdstring

The id of Lens.

Changes

No recorded changes to this operation across all 70 revisions of this API.