SAsalesforce
perspectives

Find perspectives

Changed on

Find a perspective or perspectives. You may query using field filters with asterisk (*) wildcards. You may also optionally specify sort, limit, offset, and a list of fields to include in the response. The global default limit will apply if no limit param is specified.

get/perspectives

Request

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

Query parameters

fieldsstring[]

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

sortstring[]

Specify the sort order using a field name, e.g. "...?sort=name". Prepend the field name with a minus sign to specify descending order, e.g. '...?sort=-name'.

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

namestring

Filter by name; asterisk (*) wildcards ok.

rootSubjectstring

Filter by root subject; asterisk (*) wildcards ok.

createdAtstring

Filter by time period when perspectives were created.

updatedAtstring

Filter by time period when perspectives were updated.

Response

Success, returns a list of perspectives.

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

  • v161c43b67559bRevision changes
    • info

      added the new optional query request parameter createdAt

    • info

      added the new optional query request parameter updatedAt