git.iko.soy/typeable/pagerduty
on gh-pages help sign in
typeable/pagerduty/Network-PagerDuty-REST-Incidents-Notes.html
5 lines 10.0 kB history raw
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Network.PagerDuty.REST.Incidents.Notes</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
2window.onload = function () {pageLoad();setSynopsis("mini_Network-PagerDuty-REST-Incidents-Notes.html");};
3//]]>
4</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">pagerduty-0.0.1.1: Client library for PagerDuty Integration and REST APIs.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Network.PagerDuty.REST.Incidents.Notes</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">List Notes</a></li><li><a href="#g:2">Create Note</a></li><li><a href="#g:3">Types</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The Incident Notes API allows you to add notes to a specified incident.</p><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/incidents/notes">http://developer.pagerduty.com/documentation/rest/incidents/notes</a></p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:listNotes">listNotes</a> :: <a href="Network-PagerDuty-Integration.html#t:IncidentId">IncidentId</a> -&gt; <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s [<a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a>]</li><li class="src short"><span class="keyword">data</span> <a href="#t:CreateNote">CreateNote</a></li><li class="src short"><a href="#v:createNote">createNote</a> :: <a href="Network-PagerDuty-Integration.html#t:IncidentId">IncidentId</a> -&gt; <a href="Network-PagerDuty-Integration.html#t:RequesterId">RequesterId</a> -&gt; <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:CreateNote">CreateNote</a> s <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a></li><li class="src short"><a href="#v:createNoteBasic">createNoteBasic</a> :: <a href="Network-PagerDuty-Integration.html#t:IncidentId">IncidentId</a> -&gt; <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:CreateNote">CreateNote</a> s <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a></li><li class="src short"><a href="#v:cnContent">cnContent</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:CreateNote">CreateNote</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><span class="keyword">data</span> <a href="#t:Note">Note</a></li><li class="src short"><a href="#v:nId">nId</a> :: Lens' <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a> <a href="Network-PagerDuty-Integration.html#t:NoteId">NoteId</a></li><li class="src short"><a href="#v:nCreatedAt">nCreatedAt</a> :: Lens' <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a> UTCTime</li><li class="src short"><a href="#v:nUser">nUser</a> :: Lens' <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a> <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></li><li class="src short"><a href="#v:nContent">nContent</a> :: Lens' <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a> Text</li></ul></div><div id="interface"><h1 id="g:1">List Notes</h1><div class="top"><p class="src"><a name="v:listNotes" class="def">listNotes</a> :: <a href="Network-PagerDuty-Integration.html#t:IncidentId">IncidentId</a> -&gt; <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-Integration.html#t:Empty">Empty</a> s [<a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a>]</p><div class="doc"><p>List existing notes for the specified incident.</p><pre>GET /incidents/:incident_id/notes</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/incidents/notes/create">http://developer.pagerduty.com/documentation/rest/incidents/notes/create</a></p></div></div><h1 id="g:2">Create Note</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CreateNote" class="def">CreateNote</a></p><div class="subs instances"><p id="control.i:CreateNote" class="caption collapser" onclick="toggleSection('i:CreateNote')">Instances</p><div id="section.i:CreateNote" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:CreateNote">CreateNote</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:CreateNote">CreateNote</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:CreateNote">CreateNote</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">QueryLike <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:CreateNote">CreateNote</a></td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:createNote" class="def">createNote</a> :: <a href="Network-PagerDuty-Integration.html#t:IncidentId">IncidentId</a> -&gt; <a href="Network-PagerDuty-Integration.html#t:RequesterId">RequesterId</a> -&gt; <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:CreateNote">CreateNote</a> s <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a></p><div class="doc"><p>Create a new note for the specified incident.</p><pre>POST /incidents/:incident_id/notes</pre><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/rest/incidents/notes/create">http://developer.pagerduty.com/documentation/rest/incidents/notes/create</a></p></div></div><div class="top"><p class="src"><a name="v:createNoteBasic" class="def">createNoteBasic</a> :: <a href="Network-PagerDuty-Integration.html#t:IncidentId">IncidentId</a> -&gt; <a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:CreateNote">CreateNote</a> s <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a></p><div class="doc"><p>A version of <code><a href="Network-PagerDuty-REST-Incidents-Notes.html#v:createNote">createNote</a></code> which uses HTTP Basic authentication and
5 doesn't require a <code><a href="Network-PagerDuty-Integration.html#t:RequesterId">RequesterId</a></code>.</p></div></div><div class="top"><p class="src"><a name="v:cnContent" class="def">cnContent</a> :: Lens' (<a href="Network-PagerDuty-Integration.html#t:Request">Request</a> <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:CreateNote">CreateNote</a> s b) (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Maybe.html#t:Maybe">Maybe</a> Text)</p><div class="doc"><p>The note content.</p></div></div><h1 id="g:3">Types</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Note" class="def">Note</a></p><div class="subs instances"><p id="control.i:Note" class="caption collapser" onclick="toggleSection('i:Note')">Instances</p><div id="section.i:Note" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.2/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a></td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:nId" class="def">nId</a> :: Lens' <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a> <a href="Network-PagerDuty-Integration.html#t:NoteId">NoteId</a></p></div><div class="top"><p class="src"><a name="v:nCreatedAt" class="def">nCreatedAt</a> :: Lens' <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a> UTCTime</p></div><div class="top"><p class="src"><a name="v:nUser" class="def">nUser</a> :: Lens' <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a> <a href="Network-PagerDuty-REST-Users.html#t:User">User</a></p></div><div class="top"><p class="src"><a name="v:nContent" class="def">nContent</a> :: Lens' <a href="Network-PagerDuty-REST-Incidents-Notes.html#t:Note">Note</a> Text</p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.14.3</p></div></body></html>