PUT api/v1/notes/{noteTag}

Updates an existing note

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 3

CygNet Bridge API license type: Base

Request Information

URI Parameters

Name	Description	Type	Additional information
noteTag		string	Required

Body Parameters

Name	Description	Type	Additional information
note	New parameters to update the note with	NoteDTO	Required

Request Formats

application/json, text/json

Sample:

{
  "note": {
    "noteTag": "[5410]CYGSITE.NOTE~2",
    "body": "UpdatedTimestamp will be ignored if submitted",
    "type": "NOTE",
    "summary": "This is a note summary",
    "createdUserId": "IGNORED VALUE",
    "startTimestamp": "2018-01-08T10:25:33",
    "endTimestamp": "2018-01-09T10:25:33",
    "updatedTimestamp": "2018-01-10T14:56:32",
    "facilityAssociations": [
      "CYGSITE.UIS::PEAK_WL"
    ],
    "pointAssociations": [
      "CYGSITE.UIS.00004903"
    ],
    "textAttributes": [
      "atval1",
      "atval2",
      "",
      "atval3",
      ""
    ],
    "tableAttributes": [
      "",
      "NOTTBL2",
      "",
      "NOTTBL4",
      ""
    ],
    "yesNoAttributes": [
      false,
      false,
      false,
      true,
      false
    ]
  }
}

Response Information

Resource Description

Name	Description	Type	Additional information
note	Updated note	NoteDTO	None

Response Formats

application/json, text/json

Sample:

{
  "note": {
    "noteTag": "[5410]CYGSITE.NOTE~2",
    "body": "This is a ranged note",
    "type": "NOTE",
    "summary": "This note is a custom note type",
    "createdUserId": "DOMAIN\\user.name",
    "startTimestamp": "2018-01-08T10:25:33",
    "endTimestamp": "2018-01-09T10:25:33",
    "updatedTimestamp": "2018-01-10T14:56:32",
    "facilityAssociations": [
      "CYGSITE.UIS::PEAK_WL"
    ],
    "pointAssociations": [
      "CYGSITE.UIS.00004903"
    ],
    "textAttributes": [
      "atval1",
      "atval2",
      "",
      "atval3",
      ""
    ],
    "tableAttributes": [
      "",
      "NOTTBL2",
      "",
      "NOTTBL4",
      ""
    ],
    "yesNoAttributes": [
      false,
      false,
      false,
      true,
      false
    ]
  }
}