GET api/v1/notes/{noteTag}

Retrieves the note for a specified note tag

CygNet Access Requirements

    CygNet ACS security: BRDGAPI ACCESS 1

    CygNet Bridge API license type: Base

Request Information

URI Parameters

NameDescriptionTypeAdditional information
noteTag

CygNet note tag ([DomainId]Site.Service~NOTENUMBER)

 string

Required

Body Parameters

None

Response Information

Resource Description

NameDescriptionTypeAdditional information
note

Note DTO

 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": [],
    "textAttributes": [
      "atval1",
      "atval2",
      "",
      "atval3",
      ""
    ],
    "tableAttributes": [
      "",
      "NOTTBL2",
      "",
      "NOTTBL4",
      ""
    ],
    "yesNoAttributes": [
      false,
      false,
      false,
      true,
      false
    ]
  }
}