SAsalesforce
samples

Delete sample related link

Delete the specified related link of the specified sample.

delete/samples/{key}/relatedLinks/{relName}

Request

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

Path parameters

keystring required

The name of the sample for which related link needs to be deleted.

relNamestring required

The name of the related link to delete.

Response

Success, returns the updated sample.

messageBodystring

Optional message about the sample value. Informational only--not used to determine the status of the sample. It's up to the lens whether/how to display this, will typically be displayed only on hover or click.

messageCodestring

Optional 5-charater code about the sample value. Informational only--not used to determine the status of the sample. It's up to the lens whether/how to display this, will typically be displayed without having to hover or click.

status'Critical' | 'Invalid' | 'Timeout' | 'Warning' | 'Info' | 'OK'

Status.

previousStatus'Critical' | 'Invalid' | 'Timeout' | 'Warning' | 'Info' | 'OK'

Previous Status.

valuestring

Stored as a string but will be treated as whatever the aspect’s valueType was specified as, i.e. [BOOLEAN|NUMERIC|PERCENT]. If timeout occurs, value is set to null.

providerstring

User who provided this sample.

createdAtstring

TODO

updatedAtstring

TODO

statusChangedAtstring

Time at which the status changed from one state to another.

Changes

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