POST api/v1/notes/create

Creates a new note

CygNet Access Requirements

CygNet ACS security: BRDGAPI ACCESS 3

CygNet Bridge API license type: Base

Request Information

URI Parameters

None

Body Parameters

Request object containing the data for the new note: equal start and end times = point-in-time note; different start and end times = ranged note, with indeterminate end time if value is null

Name	Description	Type	Additional information
siteService	CygNet site and service (Site.Service) of the Note Service (NOTE)	string	Required
body	Note body text	string	Required
type	Note type	string	Required
summary	Note summary text	string	Required
start	Start date and time of note	date	Required
end	End date and time of note (if null, end is not yet defined)	date	None
facilityAssociations	List of facility associations	Collection of string	Required
pointAssociations	List of point associations	Collection of string	Required
textAttributes	List of text attributes	Collection of string	Required
tableAttributes	List of table attributes	Collection of string	Required
yesNoAttributes	List of yes/no attributes	Collection of boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "siteService": "CYGSITE.NOTE",
  "body": "This is the note sample body text.",
  "type": "NOTE",
  "summary": "This is the note summary text.",
  "start": "2018-05-03T17:00:00-07:00",
  "end": "2018-05-03T17:00:00-07:00",
  "facilityAssociations": [
    "CYGSITE.UIS::ANTIER_WL"
  ],
  "pointAssociations": [
    "CYGSITE.UIS::ANTIER_GM.ANCO",
    "CYGSITE.UIS::ANTIER_GM.ANCO2"
  ],
  "textAttributes": [
    "Text attribute value 1",
    "Text attribute value 2",
    "Text attribute value 3",
    "Text attribute value 4",
    "Text attribute value 5"
  ],
  "tableAttributes": [
    "NTBL1VAL1",
    "NTBL2VAL1",
    "NTBL3VAL1",
    "NTBL4VAL1",
    "NTBL5VAL1"
  ],
  "yesNoAttributes": [
    false,
    true,
    true,
    false,
    false
  ]
}

Response Information

Resource Description

The new note created

Name	Description	Type	Additional information
noteTag	The note tag generated for the created note	string	None

Response Formats

application/json, text/json

Sample:

{
  "noteTag": "[5410]CYGSITE.NOTE~43"
}