SAsalesforce
perspectives

Update perspective (partial)

Update the specified perspective. If a field is not included in the query body, that field will not be updated.

patch/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 update.

Request body

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.

lensIdstring

The id of Lens.

ownerstring

The name of the user to assign as the owner. Defaults to the user that created it

Response

Success, returns the updated 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.