Manage Client Note

Updates, gets, and deletes a client note.

Gets client note details.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • noteIdstringrequired

    Unique Identifier (UUID) of the client notes

Responses

  • idinteger

  • subjectstring

    Subject of note.

  • descriptionstring

    Summary describing the note.

  • createdTimestring

  • updatedTimestring

  • startTimestring

    Date and time from which the note is valid. This is applicable only if expiryDateType is set as 2.

  • expiryTimestring

    Date and time on which the note expires. This field is mandatory if expiryDateType is set as 2.

  • expiryDateTypeinteger

    Type of expiry. If expiryDateType is set as 1, it indicates Never Expire. If expiryDateType is set as 2, it indicates Validity period.

  • createdByobject

Loading Examples...

Updates client note details.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • noteIdstringrequired

    Unique Identifier (UUID) of the client notes

Request Body

application/json

  • idinteger

  • subjectstring

    Subject of note.

  • descriptionstring

    Summary describing the note.

  • createdTimestring

  • updatedTimestring

  • startTimestring

    Date and time from which the note is valid. This is applicable only if expiryDateType is set as 2.

  • expiryTimestring

    Date and time on which the note expires. This field is mandatory if expiryDateType is set as 2.

  • expiryDateTypeinteger

    Type of expiry. If expiryDateType is set as 1, it indicates Never Expire. If expiryDateType is set as 2, it indicates Validity period.

  • createdByobject

Loading Examples...

Responses

  • idinteger

  • subjectstring

    Subject of note.

  • descriptionstring

    Summary describing the note.

  • createdTimestring

  • updatedTimestring

  • startTimestring

    Date and time from which the note is valid. This is applicable only if expiryDateType is set as 2.

  • expiryTimestring

    Date and time on which the note expires. This field is mandatory if expiryDateType is set as 2.

  • expiryDateTypeinteger

    Type of expiry. If expiryDateType is set as 1, it indicates Never Expire. If expiryDateType is set as 2, it indicates Validity period.

  • createdByobject

Loading Examples...

Deletes a client note and deletes notes from the resource-level.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

  • noteIdstringrequired

    Unique Identifier (UUID) of the client notes

Responses

200OK