Sign in
Notes

Create Note

Create a new note attached to a registry resource.

post/notes

Request body

bodystring required
confidence'observed' | 'suspected' | 'verified'

Author-supplied confidence in a note (matches the spec NoteConfidence enum).

related_execution_idstring nullable
source'agent' | 'human' | 'platform'

Origin tag for a note (matches the spec NoteSource enum).

type'auth_quirk' | 'usage_hint' | 'execution_feedback' | 'correction'

Category of a note (matches the spec NoteType enum).

Response

Successful Response

{"stackTrail":"paths:/notes:post:responses:201:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 3 of the 85 revisions of this API.151444

  • d65fcba0d25a6228See the full diff
    • ▲

      added the new required request property body

      new-required-request-property

    • ▲

      removed subschema #1 from the confidence request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 from the source request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 from the type request property anyOf list

      request-property-any-of-removed

    • ▲

      the resource request property type/format changed from string/ to object/

      request-property-type-changed

    • ▲

      the detail response's property type/format changed from array/ to string/ for status 422

      response-property-type-changed

    • ●

      removed the request property execution_id

      request-property-removed

    • ●

      removed the request property note

      request-property-removed

    • ○

      api operation id create_note_notes_post removed and replaced with createNote

      api-operation-id-removed

    • ○

      the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security AgentOauthAccessToken was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security HumanLogin was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security JenticApiKey was removed from the API

      api-security-removed

    • ○

      api tag Notes added

      api-tag-added

    • ○

      api tag catalog removed

      api-tag-removed

    • ○

      added the new optional request property related_execution_id

      new-optional-request-property

    • ○

      added the new optional request property resource/api

      new-optional-request-property

    • ○

      added the new optional request property resource/credential_id

      new-optional-request-property

    • ○

      added the new optional request property resource/execution_id

      new-optional-request-property

    • ○

      added the new optional request property resource/operation_id

      new-optional-request-property

    • ○

      added NoteConfidence to the confidence request property anyOf list

      request-property-any-of-added

    • ○

      added NoteSource to the source request property anyOf list

      request-property-any-of-added

    • ○

      added NoteType to the type request property anyOf list

      request-property-any-of-added

    • ○

      media type application/json was changed to a more specific media type application/problem+json for the response status 422

      response-media-type-name-specialized

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the optional property code to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property errors to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property instance to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property title to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property type to the response with the 422 status

      response-optional-property-added

    • ○

      the response property detail became required for the status 422

      response-property-became-required

    This revision also has 61 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5a765d68c56f1See the full diff
    • ○

      the endpoint scheme security AgentOauthAccessToken was added to the API

      api-security-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76e8f606372891215See the full diff
    • ▲

      added the new required request property note

      new-required-request-property

    • ▲

      removed NoteConfidence from the confidence request property anyOf list

      request-property-any-of-removed

    • ▲

      removed NoteSource from the source request property anyOf list

      request-property-any-of-removed

    • ▲

      removed NoteType from the type request property anyOf list

      request-property-any-of-removed

    • ▲

      the resource request property type/format changed from object/ to string/

      request-property-type-changed

    • ▲

      media type application/problem+json was changed to a more general media type application/json for the response status 422

      response-media-type-name-generalized

    • ▲

      the response property detail became optional for the status 422

      response-property-became-optional

    • ▲

      the detail response property's maxLength was unset from 4096 for the response status 422

      response-property-max-length-unset

    • ▲

      the detail response's property type/format changed from string/ to array/ for status 422

      response-property-type-changed

    • ●

      removed the request property body

      request-property-removed

    • ●

      removed the request property related_execution_id

      request-property-removed

    • ●

      removed the request property resource/api

      request-property-removed

    • ●

      removed the request property resource/credential_id

      request-property-removed

    • ●

      removed the request property resource/execution_id

      request-property-removed

    • ●

      removed the request property resource/operation_id

      request-property-removed

    • ●

      removed the optional property code from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property errors from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property instance from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property status from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property title from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property type from the response with the 422 status

      response-optional-property-removed

    • ○

      api operation id createNote removed and replaced with create_note_notes_post

      api-operation-id-removed

    • ○

      the endpoint scheme security HumanLogin was added to the API

      api-security-added

    • ○

      the endpoint scheme security JenticApiKey was added to the API

      api-security-added

    • ○

      the endpoint scheme security BearerAuth was removed from the API

      api-security-removed

    • ○

      api tag catalog added

      api-tag-added

    • ○

      api tag Notes removed

      api-tag-removed

    • ○

      added the new optional request property execution_id

      new-optional-request-property

    • ○

      added subschema #1 to the confidence request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #1 to the source request property anyOf list

      request-property-any-of-added

    • ○

      added subschema #1 to the type request property anyOf list

      request-property-any-of-added

    • ○

      removed the non-success response with the status 400

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 401

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 503

      response-non-success-status-removed

    This revision also has 179 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog