Acknowledge this exact active occurrence without resolving the source condition.

POST

/api/workspace/attention-signals/{attentionSignalId}/acknowledge

curl --request POST \
  --url https://example.com/api/workspace/attention-signals/example/acknowledge \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Note": "example" }'

Authorizations

• WorkspaceBearer

Parameters

Path Parameters

attentionSignalId

required

string

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body

Acknowledge the exact routed occurrence, with an optional note of at most 2,000 characters.

object

Note

string

nullable

Example^generated

{
  "Note": "example"
}

Acknowledge the exact routed occurrence, with an optional note of at most 2,000 characters.

object

Note

string

nullable

Example^generated

{
  "Note": "example"
}

Acknowledge the exact routed occurrence, with an optional note of at most 2,000 characters.

object

Note

string

nullable

Example^generated

{
  "Note": "example"
}

Responses

200

OK

Media typeapplication/json

object

Data

Immutable acknowledgement facts of one exact signal occurrence.

object

AttentionSignalId

string

nullable

AcknowledgedByUserId

string

nullable

AcknowledgedByDisplayName

string

nullable

AcknowledgedAtUtc

string format: date-time

Note

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

Media typeapplication/json

object

Data

Immutable acknowledgement facts of one exact signal occurrence.

object

AttentionSignalId

string

nullable

AcknowledgedByUserId

string

nullable

AcknowledgedByDisplayName

string

nullable

AcknowledgedAtUtc

string format: date-time

Note

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

Media typeapplication/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media typeapplication/json

object

Data

Immutable acknowledgement facts of one exact signal occurrence.

object

AttentionSignalId

string

nullable

AcknowledgedByUserId

string

nullable

AcknowledgedByDisplayName

string

nullable

AcknowledgedAtUtc

string format: date-time

Note

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

Media typeapplication/json

object

Data

Immutable acknowledgement facts of one exact signal occurrence.

object

AttentionSignalId

string

nullable

AcknowledgedByUserId

string

nullable

AcknowledgedByDisplayName

string

nullable

AcknowledgedAtUtc

string format: date-time

Note

string

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}