Skip to main content

Sensitive API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
sensitiveScoresIncrementPOST /sensitive/{sensitive}/scores/increment'/sensitive/{sensitive}/scores/increment' [POST]
sensitiveSnapshotGET /sensitive/{sensitive}/sensitive/{sensitive} [GET]
updateSensitivePOST /sensitive/update/sensitive/update [POST]

sensitiveScoresIncrement

sensitiveScoresIncrement()

This will take in a SeededScoreIncrement and will increment the material relative to the incoming body.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.SensitiveApi(configuration)

const body: Pieces.SensitiveScoresIncrementRequest = {
// string | This is a uuid that represents a sensitive.
sensitive: sensitive_example,
// SeededScoreIncrement (optional)
seededScoreIncrement: ,
};

apiInstance.sensitiveScoresIncrement(body).then((data: void (empty response body)) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
seededScoreIncrementSeededScoreIncrement
sensitive[string]This is a uuid that represents a sensitive.defaults to undefined

Return type

void (empty response body)

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

sensitiveSnapshot

Sensitive sensitiveSnapshot()

This will get a specific sensitive via the sensitive uuid.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.SensitiveApi(configuration)

const body: Pieces.SensitiveSnapshotRequest = {
// string
sensitive: sensitive_example,
};

apiInstance.sensitiveSnapshot(body).then((data: Sensitive) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
sensitive[string]defaults to undefined

Return type

Sensitive

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

updateSensitive

Sensitive updateSensitive()

This will update a specific sensitive

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.SensitiveApi(configuration)

const body: Pieces.UpdateSensitiveRequest = {
// Sensitive | (optional)
sensitive: ,
};

apiInstance.updateSensitive(body).then((data: Sensitive) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
sensitiveSensitive

Return type

Sensitive

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-