POST api/v1/notes

Retrieves a list of notes

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 1

CygNet Bridge API license type: Base

Request Information

URI Parameters

None

Body Parameters

Request object for retrieving notes

Name	Description	Type	Additional information
siteService	CygNet site and service (Site.Service) of the Note Service (NOTE)	string	Required
facilityAssociations	List of facility tags to retrieve associated notes for	Collection of string	Required
pointAssociations	List of point tags to retrieve associated notes for	Collection of string	Required
start	Start date and time of range to search for notes	date	Required
end	End date and time of range to search for notes	date	Required
type	Note type to retrieve (if not specified, retrieve all note types)	string	None
getBody	If false, don't include body text in retrieved notes	boolean	Required
getAssociations	If false, don't include facility or point associations in retrieved notes	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "siteService": "CYGSITE.NOTE",
  "facilityAssociations": [
    "CYGSITE.UIS::PEAK_WL",
    "CYGSITE.UIS::CALVIN_CDP"
  ],
  "pointAssociations": [
    "CYGSITE.UIS.00004638:ANTIER_GM_ANHEX:ANTIER_GM.ANHEX",
    "CYGSITE.UIS.00005065:BRADY_GM_ANHEP:BRADY_GM.ANHEP"
  ],
  "start": "2017-12-31T16:00:00-08:00",
  "end": "2018-01-31T16:00:00-08:00",
  "type": "NOTE",
  "getBody": true,
  "getAssociations": true
}

Response Information

Resource Description

All notes found matching the request parameters

Name	Description	Type	Additional information
notes	List of notes	Collection of NoteDTO	None

Response Formats

application/json, text/json

Sample:

{
  "notes": [
    {
      "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
      ]
    },
    {
      "noteTag": "[5410]CYGSITE.NOTE~3",
      "body": "This is a ranged TBD note",
      "type": "CUSTOM NOTE",
      "summary": "TBD ranged note",
      "createdUserId": "DOMAIN\\user.name",
      "startTimestamp": "2018-01-01T14:17:19",
      "endTimestamp": null,
      "updatedTimestamp": "2018-01-10T14:19:03",
      "facilityAssociations": null,
      "pointAssociations": [
        "CYGSITE.UIS.00004902",
        "CYGSITE.UIS.00004903"
      ],
      "textAttributes": [
        "at 1",
        "at 2",
        "",
        "at 4",
        ""
      ],
      "tableAttributes": [
        "",
        "NOTTBL2",
        "",
        "NOTTBL4B",
        ""
      ],
      "yesNoAttributes": [
        false,
        true,
        false,
        false,
        false
      ]
    }
  ]
}